├── .github └── workflows │ └── build.yml ├── .gitignore ├── .stack-all ├── CHANGELOG.md ├── LICENSE ├── README.md ├── TODO ├── data └── template.cabal.tmpl ├── hkgr.cabal ├── src └── Main.hs ├── stack-lts13.yaml ├── stack-lts14.yaml └── stack.yaml /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: build 2 | on: 3 | push: 4 | branches: 5 | - main 6 | pull_request: 7 | branches: 8 | - main 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | strategy: 13 | matrix: 14 | ghc: ['9.10', '9.8', '9.6', '9.4', '9.2', '9.0', '8.10', '8.8', '8.6', '8.4', '8.2'] 15 | name: Haskell GHC ${{ matrix.ghc }} 16 | steps: 17 | - uses: actions/checkout@v4 18 | - uses: haskell-actions/setup@v2 19 | with: 20 | ghc-version: ${{ matrix.ghc }} 21 | - uses: actions/cache@v4 22 | with: 23 | path: | 24 | ~/.cabal 25 | dist-newstyle 26 | key: ${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('**/*.cabal','**/cabal.project') }} 27 | restore-keys: | 28 | ${{ runner.os }}-${{ matrix.ghc }}- 29 | ${{ runner.os }}- 30 | - run: cabal update 31 | - run: cabal build 32 | - run: cabal sdist 33 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### Haskell 2 | dist 3 | dist-* 4 | cabal-dev 5 | *.o 6 | *.hi 7 | *.chi 8 | *.chs.h 9 | *.dyn_o 10 | *.dyn_hi 11 | *.prof 12 | *.aux 13 | *.hp 14 | *.eventlog 15 | .virtualenv 16 | .hsenv 17 | .hpc 18 | .cabal-sandbox/ 19 | cabal.sandbox.config 20 | cabal.config 21 | cabal.project.local 22 | .ghc.environment.* 23 | .HTF/ 24 | # Stack 25 | .stack-work/ 26 | 27 | ### IDE/support 28 | # Vim 29 | [._]*.s[a-v][a-z] 30 | [._]*.sw[a-p] 31 | [._]s[a-v][a-z] 32 | [._]sw[a-p] 33 | *~ 34 | tags 35 | 36 | # IntellijIDEA 37 | .idea/ 38 | .ideaHaskellLib/ 39 | *.iml 40 | 41 | # Atom 42 | .haskell-ghc-mod.json 43 | 44 | # VS 45 | .vscode/ 46 | 47 | # Emacs 48 | *# 49 | .dir-locals.el 50 | TAGS 51 | 52 | # other 53 | .DS_Store 54 | -------------------------------------------------------------------------------- /.stack-all: -------------------------------------------------------------------------------- 1 | [versions] 2 | # lts-12 typed-process does not have readProcessInterleaved_ 3 | oldest = lts-13 4 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## 0.4.8 (2025-05-23) 4 | - bump stack default to lts-22 5 | 6 | ## 0.4.7 (2025-03-11) 7 | - 'rename': only sed Main.hs if it exists 8 | - 'sdist': prefix "Running hlint" with '#' 9 | - 'upload': handle existing tarball from aborted build without tag 10 | - 'upload-haddock': add --force which removes existing haddock tarball 11 | 12 | ## 0.4.6 (2024-06-20) 13 | - 'new': add --license option 14 | - 'new': bump stack.yaml resolver to lts-21 15 | - add missing SUMMARY placeholder to template 16 | 17 | ## 0.4.5 (2024-05-23) 18 | - 'tagdist', 'upload': also do pristine cabal build unless --no-build 19 | 20 | ## 0.4.4 (2024-05-03) 21 | - .cabal template: add autogen-modules and update tested-with ghc versions 22 | - publish,build: output message before cabal build 23 | - use simple-cmd +-+ 24 | 25 | ## 0.4.3.2 (2023-10-20) 26 | - use a cabal.project for pristine sdist/build to ignore any parent project 27 | - .cabal template: updated tested-with ghc versions 28 | 29 | ## 0.4.3.1 (2023-07-05) 30 | - fix the template file SPDX license tag and cabal-version field placement 31 | 32 | ## 0.4.3 (2023-05-30) 33 | - bump template to Cabal 2.2 34 | - add pristine 'build' command: used before publish 35 | - use haskeline for reading user/passwd via simple-prompt 36 | 37 | ## 0.4.2 (2022-06-24) 38 | - 'new': need cabal init --license option, otherwise no LICENSE file is created 39 | - 'github': new command to add github remote for project 40 | 41 | ## 0.4.1 (2022-06-23) 42 | - 'rename' improvements 43 | - 'new': avoid error on cabal >= 3.4 by not passing --license to cabal init 44 | 45 | ## 0.4 (2022-03-27) 46 | - template.cabal: use cabal 2.0 and define hs-source-dirs 47 | - 'tagdist --existing-tag' replaces 'dist' command 48 | - 'upload': add --existing-tag for dist rather than tagdist 49 | - 'new': stack init with lts-17 50 | - 'rename': experimental command to rename a project 51 | - add '--no-hlint' option to skip running hlint 52 | (also hlint is no longer run for 'publish') 53 | 54 | ## 0.3 (2020-05-07) 55 | - only read Hackage username/password if not in ~/.cabal/config 56 | - 'upload': show newer untagged commits 57 | - 'dist': new command for a manually tagged release 58 | - fix the check for package version committed 59 | 60 | ## 0.2.7 (2020-02-27) 61 | - Main.hs: explicitly export main and add SPDX-License-Identifier 62 | - move Main.hs to src/ 63 | - handle git submodules (not --recursive yet) 64 | - use typed-process to interleave IO to display auth errors 65 | - check name and .cabal filename consistent 66 | - put tarballs in .hkgr/ 67 | - upload: error if tag no longer on branch 68 | - publish: only push up to tag 69 | 70 | ## 0.2.6.1 (2020-07-30) 71 | - upload: do not hide output since it conceals any error 72 | - new: improvements to work better with cabal-3.0 init 73 | 74 | ## 0.2.6 (2020-06-11) 75 | - tagdist: include existing tag in error message 76 | - experimental 'new' project command with user template file 77 | `~/.config/hkgr/template.cabal` 78 | - switch to cabal v2-sdist 79 | - upload: display error correctly 80 | - upload: add --force switch - to refresh tag and tarball 81 | 82 | ## 0.2.5.2 (2020-02-29) 83 | - no hlint summary 84 | - fix published message 85 | 86 | ## 0.2.5.1 (2020-02-29) 87 | - improve output for hlint and uploaded url 88 | - also check for staged changes 89 | 90 | ## 0.2.5 (2020-02-29) 91 | - check that package version is committed 92 | - use quiet cabal v1-configure and v1-sdist commands 93 | - make cabal upload quiet 94 | 95 | ## 0.2.4.1 (2020-02-11) 96 | - assert that cabal-install installed 97 | - run hlint in git checkout instead of working tree 98 | 99 | ## 0.2.4 (2019-10-05) 100 | - git push before publishing 101 | - only push up to tag 102 | 103 | ## 0.2.3 (2019-09-30) 104 | - push git tag 105 | - hlint is now a warning not an error 106 | - prefix version tags with v 107 | - surround git diff output with quote lines 108 | - catch exception for sdist 109 | 110 | ## 0.2.2 (2019-07-06) 111 | - run hlint before git tag 112 | - relax force sdist when no existing tarball 113 | - show git diff to warn project dirty 114 | 115 | ## 0.2.1 (2019-06-24) 116 | - fix creation of published symlink lockfile 117 | - tagdist before `cabal upload` if no tarball 118 | 119 | ## 0.2 (2019-06-24) 120 | - merge tag and dist commands into tagdist 121 | - if sdist fails then reset tag 122 | - drop push-tags command 123 | 124 | ## 0.1 (2019-06-24) 125 | - add published lock file: prevents tagging/dist/upload after publish 126 | - tag before sdist if no tag 127 | - push tag after publishing 128 | 129 | ## 0.0 (2019-06-08) 130 | - Initially created. 131 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Hkgr 2 | 3 | [![Hackage](https://img.shields.io/hackage/v/hkgr.svg)](https://hackage.haskell.org/package/hkgr) 4 | [![GPL-3 license](https://img.shields.io/badge/license-GPL--3-blue.svg)](LICENSE) 5 | [![GitHub CI](https://github.com/juhp/hkgr/workflows/build/badge.svg)](https://github.com/juhp/hkgr/actions) 6 | 7 | `hkgr` (pronounced "hackager") is a tool for making releases of 8 | Haskell packages on Hackage. 9 | 10 | It uses a cautious stepped iterative approach to releases. 11 | 12 | ## Example usage 13 | 14 | Here is an example of doing a release of hkgr itself. 15 | 16 | After committing the latest changes for the release, create a tag and tarball: 17 | 18 | ```shellsession 19 | $ hkgr tagdist 20 | v0.4 21 | No errors or warnings could be found in the package. 22 | Running hlint 23 | src/Main.hs:(407,9)-(408,55): Warning: Eta reduce 24 | Found: 25 | replaceHolder lbl val file 26 | = sed ["s/@" ++ lbl ++ "@/" ++ val ++ "/"] file 27 | Perhaps: 28 | replaceHolder lbl val = sed ["s/@" ++ lbl ++ "@/" ++ val ++ "/"] 29 | 30 | [] 31 | ["src/Main.hs","data/template.cabal.tmpl","README.md","CHANGELOG.md","LICENSE","hkgr.cabal"] 32 | [(NoExec,"CHANGELOG.md"),(NoExec,"LICENSE"),(NoExec,"README.md"),(NoExec,"data/template.cabal.tmpl"),(NoExec,"hkgr.cabal"),(NoExec,"src/Main.hs")] 33 | Wrote tarball sdist to /home/petersen/github/hkgr/.hkgr/hkgr-0.4.tar.gz 34 | hackage.haskell.org password: ^C 35 | ``` 36 | 37 | After fixing up, retag a new tarball with `--force` and upload candidate, 38 | in one go: 39 | 40 | ```shellsession 41 | $ hkgr upload -f 42 | Updated tag 'v0.4' (was f6d72ba) 43 | No errors or warnings could be found in the package. 44 | Running hlint 45 | [] 46 | ["src/Main.hs","data/template.cabal.tmpl","README.md","CHANGELOG.md","LICENSE","hkgr.cabal"] 47 | [(NoExec,"CHANGELOG.md"),(NoExec,"LICENSE"),(NoExec,"README.md"),(NoExec,"data/template.cabal.tmpl"),(NoExec,"hkgr.cabal"),(NoExec,"src/Main.hs")] 48 | Wrote tarball sdist to /home/petersen/github/hkgr/.hkgr/hkgr-0.4.tar.gz 49 | hackage.haskell.org password: 50 | Uploaded to https://hackage.haskell.org/package/hkgr-0.4/candidate 51 | ``` 52 | 53 | Alternatively if you had manually tagged the release with `v0.4` 54 | you can use `hkgr tagdist --existing-tag` to create a dist tarball. 55 | 56 | One can continue to `tagdist -f` and/or `upload -f` until 57 | everything looks good and CI passed etc. 58 | 59 | Then it is time to push the final tag and publish the release: 60 | 61 | ```shellsession 62 | $ hkgr publish 63 | git pushing... done 64 | Total 0 (delta 0), reused 0 (delta 0), pack-reused 0 65 | To github.com:juhp/hkgr.git 66 | * [new tag] v0.4 -> v0.4 67 | hackage.haskell.org password: 68 | Published at https://hackage.haskell.org/package/hkgr-0.4 69 | ``` 70 | 71 | ## Help 72 | 73 | `$ hkgr --version` 74 | 75 | ``` 76 | 0.4.8 77 | ``` 78 | `$ hkgr --help` 79 | 80 | ``` 81 | Hackage Release tool 82 | 83 | Usage: hkgr [--version] COMMAND 84 | 85 | 'Hackager' is a package release tool for easy Hackage workflow 86 | 87 | Available options: 88 | -h,--help Show this help text 89 | --version Show version 90 | 91 | Available commands: 92 | new setup a new project 93 | tagdist 'git tag' version and 'cabal sdist' tarball 94 | upload 'cabal upload' candidate tarball to Hackage 95 | publish git push and cabal upload --publish 96 | upload-haddock Upload candidate documentation to Hackage 97 | publish-haddock Publish documentation to Hackage 98 | build Do a local pristine build from the tarball 99 | version Show the package version from .cabal file 100 | rename Rename the Cabal package 101 | github Add github repo 102 | ``` 103 | 104 | ## Details 105 | 106 | ### tagdist 107 | `hkgr tagdist` creates a git tag and a sdist tarball from it: 108 | 109 | The `tagdist` command first reads the current package version 110 | (from the `.cabal` file in the current directory), and uses that to `git tag`. 111 | It then runs `cabal sdist` from a temporary pristine checkout of the tag 112 | to generate the dist tarball. 113 | 114 | Note that hkgr is lenient: it allows making a release with uncommitted changes 115 | in the working tree, but it will show the uncommitted changes. 116 | However the version must be committed. 117 | 118 | If the tag already exists (eg if you already ran `tagdist` earlier), 119 | and you need to add commits to the release 120 | you can use `--force` to move the tag to the latest commit 121 | and generate a new tarball off that, 122 | otherwise `tagdist` refuses to run again to prevent accidently overwriting 123 | the tag and dist tarball. 124 | 125 | One should not be able to `tagdist` on an already published 126 | (ie released) version made with hkgr, until the version is bumped. 127 | 128 | If sdist fails for some reason then hkgr tries to reset the tag. 129 | 130 | A cabal build of the tarball content is also attempted to catch any build errors 131 | from the package. 132 | 133 | Alternatively if you have already manually tagged a release with 'v' prefix 134 | you can use `--existing-tag` to create a dist tarball. 135 | 136 | ### upload 137 | `hkgr upload` uploads the tarball to Hackage as a candidate release. 138 | Like `hkgr tagdist -f`, `hkgr upload -f` can be repeated. 139 | 140 | Haddock draft documentation can also be uploaded once if desired 141 | with `hkgr upload-haddock`. 142 | 143 | If you have an existing version tag (starting with `v`) you can use 144 | the `--existing-tag` option to skip the tagging step (like for `tagdist`). 145 | 146 | ### publish 147 | `hkgr publish` releases the tarball to Hackage, after doing a pristine 148 | local build and git pushing the tag and its commits to origin. 149 | 150 | If it succeeds, then hkgr creates a "published lockfile" in `.hkgr/`. 151 | 152 | (Then hkgr will refuse to do further commands on the released version.) 153 | 154 | Optionally one can publish haddock docs with `hkgr publish-haddock`. 155 | 156 | ### build 157 | `hkgr build` will try to do a pristine build of the latest created tarball 158 | for the tag. This is useful for catching missing files from the tarball, 159 | preventing brownbag releases. 160 | 161 | ### new 162 | `hkgr new` creates a new project. 163 | 164 | If you don't pass a name it will try to check and use the current directory name. 165 | 166 | It uses `cabal init` to setup various files but replaces the .cabal file 167 | with a template stored in `~/.config/hkgr/template.cabal` which the user 168 | can freely customize. 169 | 170 | A `stack.yaml` file and git repo is also set up. 171 | 172 | ### github 173 | (One can use `gh repo create` etc to create the project repo on Github) 174 | and then `hkgr github` to add the github remote to your project. 175 | 176 | ## Requirements 177 | hkgr uses `cabal-install` >=2, `git`, and also `hlint` if available. 178 | 179 | ## Contribute 180 | `hkgr` is licensed and distributed under the GPL version 3 or later. 181 | 182 | Reports and contributions are welcome at . 183 | -------------------------------------------------------------------------------- /TODO: -------------------------------------------------------------------------------- 1 | - allow upload with existing tag but no existing tarball 2 | 3 | - cannot publish if already pushed and tag not on HEAD 4 | 5 | - add or --commit (alternative to force) 6 | 7 | - combine upload -f and upload-haddock 8 | - diff command 9 | * add github actions 10 | 11 | - support stack (stkgr?) 12 | - short help 13 | - check/warning about unpushed tags 14 | - run testsuite 15 | - use v2 commands for cabal-install-3 16 | - prepare changelog from git log 17 | - check cabal-install version 18 | - check published on Hackage (drop lockfiles) 19 | - warn about doc files in datadir 20 | - do not error if remote branch doesn't exist? ie offer to create it 21 | 22 | - --dryrun 23 | 24 | - `change-license` command 25 | -------------------------------------------------------------------------------- /data/template.cabal.tmpl: -------------------------------------------------------------------------------- 1 | cabal-version: 2.2 2 | name: @PROJECT@ 3 | version: 0.1.0 4 | synopsis: @SUMMARY@ 5 | description: 6 | Short paragraph here 7 | license: @LICENSE@ 8 | license-file: LICENSE 9 | author: @NAME@ <@EMAIL@> 10 | maintainer: @NAME@ <@EMAIL@> 11 | copyright: @YEAR@ @NAME@ <@EMAIL@> 12 | category: Unclassified 13 | homepage: https://github.com/@USER@/@PROJECT@ 14 | bug-reports: https://github.com/@USER@/@PROJECT@/issues 15 | build-type: Simple 16 | -- extra-doc-files: README.md 17 | -- ChangeLog.md 18 | -- tested-with: GHC == 8.10.7 19 | -- || == 9.0.2 20 | -- || == 9.2.8 21 | -- || == 9.4.8 22 | -- || == 9.6.5 23 | -- || == 9.8.2 24 | 25 | source-repository head 26 | type: git 27 | location: https://github.com/@USER@/@PROJECT@.git 28 | 29 | executable @PROJECT@ 30 | main-is: Main.hs 31 | -- other-modules: Paths_@PROJECT_@ 32 | -- autogen-modules: Paths_@PROJECT_@ 33 | hs-source-dirs: src 34 | build-depends: base < 5, 35 | @PROJECT@ 36 | default-language: Haskell2010 37 | ghc-options: -Wall 38 | if impl(ghc >= 8.0) 39 | ghc-options: -Wcompat 40 | -Widentities 41 | -Wincomplete-uni-patterns 42 | -Wincomplete-record-updates 43 | -Wredundant-constraints 44 | if impl(ghc >= 8.2) 45 | ghc-options: -fhide-source-paths 46 | if impl(ghc >= 8.4) 47 | ghc-options: -Wmissing-export-lists 48 | -Wpartial-fields 49 | if impl(ghc >= 8.10) 50 | ghc-options: -Wunused-packages 51 | 52 | library 53 | build-depends: base < 5 54 | default-language: Haskell2010 55 | exposed-modules: MyLib 56 | hs-source-dirs: src 57 | 58 | ghc-options: -Wall 59 | if impl(ghc >= 8.0) 60 | ghc-options: -Wcompat 61 | -Widentities 62 | -Wincomplete-uni-patterns 63 | -Wincomplete-record-updates 64 | -Wredundant-constraints 65 | if impl(ghc >= 8.2) 66 | ghc-options: -fhide-source-paths 67 | if impl(ghc >= 8.4) 68 | ghc-options: -Wmissing-export-lists 69 | -Wpartial-fields 70 | if impl(ghc >= 8.10) 71 | ghc-options: -Wunused-packages 72 | -------------------------------------------------------------------------------- /hkgr.cabal: -------------------------------------------------------------------------------- 1 | cabal-version: 2.0 2 | name: hkgr 3 | version: 0.4.8 4 | synopsis: Simple Hackage release workflow for package maintainers 5 | description: 6 | Hkgr (Hackager) is a tool to help make new releases of 7 | Haskell packages, with commands for git tagging, pristine sdist, 8 | and uploading to Hackage. 9 | There is also a command for creating a new local project. 10 | homepage: https://github.com/juhp/hkgr 11 | bug-reports: https://github.com/juhp/hkgr/issues 12 | license: GPL-3 13 | license-file: LICENSE 14 | author: Jens Petersen 15 | maintainer: Jens Petersen 16 | copyright: 2019-2025 Jens Petersen 17 | category: Util 18 | build-type: Simple 19 | data-dir: data 20 | data-files: template.cabal.tmpl 21 | extra-doc-files: README.md 22 | , CHANGELOG.md 23 | tested-with: GHC == 9.10 || == 9.8 || == 9.6 || == 9.4 || == 9.2 24 | || == 9.0 || == 8.10 || == 8.8 || == 8.6 || == 8.4 25 | || == 8.2 26 | 27 | source-repository head 28 | type: git 29 | location: https://github.com/juhp/hkgr.git 30 | 31 | executable hkgr 32 | main-is: src/Main.hs 33 | other-modules: Paths_hkgr 34 | autogen-modules: Paths_hkgr 35 | 36 | build-depends: base < 5 37 | , bytestring 38 | , directory >= 1.3.1.0 39 | , extra 40 | , filepath 41 | , simple-cabal >= 0.1.0 42 | , simple-cmd 43 | , simple-cmd-args >= 0.1.6 44 | , simple-prompt >= 0.2 45 | , typed-process 46 | , xdg-basedir 47 | 48 | ghc-options: -Wall 49 | if impl(ghc >= 8.0) 50 | ghc-options: -Wcompat 51 | -Widentities 52 | -Wincomplete-uni-patterns 53 | -Wincomplete-record-updates 54 | -Wredundant-constraints 55 | if impl(ghc >= 8.2) 56 | ghc-options: -fhide-source-paths 57 | if impl(ghc >= 8.4) 58 | ghc-options: -Wmissing-export-lists 59 | -Wpartial-fields 60 | if impl(ghc >= 8.10) 61 | ghc-options: -Wunused-packages 62 | 63 | default-language: Haskell2010 64 | default-extensions: OverloadedStrings 65 | -------------------------------------------------------------------------------- /src/Main.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE CPP #-} 2 | 3 | module Main (main) where 4 | 5 | #if !MIN_VERSION_base(4,8,0) 6 | import Control.Applicative (pure, (<$>)) 7 | #endif 8 | 9 | import Control.Exception (bracket_, onException) 10 | import Control.Monad.Extra 11 | import qualified Data.ByteString.Lazy.Char8 as B 12 | import Data.Char 13 | import Data.List.Extra 14 | import Data.Maybe 15 | import Data.Version.Extra 16 | import SimpleCabal 17 | import SimpleCmd ((+-+)) 18 | import SimpleCmdArgs 19 | import SimplePrompt (promptNonEmpty, promptPassword) 20 | import System.Directory 21 | import System.Environment.XDG.BaseDir 22 | import System.Exit (ExitCode (..)) 23 | import System.FilePath 24 | import System.IO (BufferMode(NoBuffering), hSetBuffering, stdout) 25 | import qualified System.Process.Typed as P 26 | import Paths_hkgr (getDataFileName, version) 27 | 28 | main :: IO () 29 | main = do 30 | hSetBuffering stdout NoBuffering 31 | simpleCmdArgs (Just version) "Hackage Release tool" 32 | "'Hackager' is a package release tool for easy Hackage workflow" $ 33 | subcommands 34 | [ Subcommand "new" "setup a new project" $ 35 | newCmd 36 | <$> optional (strOptionWith 'l' "license" "LICENSE" "Specify license") 37 | <*> optional (strArg "PROJECT") 38 | , Subcommand "tagdist" "'git tag' version and 'cabal sdist' tarball" $ 39 | tagDistCmd 40 | <$> existingTag 41 | <*> forceOpt "Move existing tag" 42 | <*> hlintOpt 43 | <*> nobuildOpt 44 | , Subcommand "upload" "'cabal upload' candidate tarball to Hackage" $ 45 | uploadCmd False 46 | <$> existingTag 47 | <*> forceOpt "Move existing tag" 48 | <*> hlintOpt 49 | <*> nobuildOpt 50 | <*> pure False 51 | , Subcommand "publish" "git push and cabal upload --publish" $ 52 | uploadCmd True False False True 53 | <$> nobuildOpt 54 | <*> switchWith 'U' "no-upload" "Do not upload to Hackage" 55 | , Subcommand "upload-haddock" "Upload candidate documentation to Hackage" $ 56 | upHaddockCmd False 57 | <$> forceOpt "rebuild doc tarball" 58 | , Subcommand "publish-haddock" "Publish documentation to Hackage" $ 59 | upHaddockCmd True 60 | <$> forceOpt "rebuild doc tarball" 61 | , Subcommand "build" "Do a local pristine build from the tarball" $ 62 | pure pristineBuildCmd 63 | , Subcommand "version" "Show the package version from .cabal file" $ 64 | pure showVersionCmd 65 | , Subcommand "rename" "Rename the Cabal package" $ 66 | renameCmd 67 | <$> strArg "NEWNAME" 68 | , Subcommand "github" "Add github repo" $ 69 | pure githubCmd 70 | ] 71 | where 72 | forceOpt = switchWith 'f' "force" 73 | 74 | existingTag = 75 | switchWith 'T' "existing-tag" "Use existing tag to create tarball" 76 | 77 | hlintOpt = 78 | switchWith 'H' "no-hlint" "Skip running hlint" 79 | 80 | nobuildOpt = 81 | switchWith 'N' "no-build" "Do not perform local sanity build" 82 | 83 | git :: String -> [String] -> P.ProcessConfig () () () 84 | git c args = P.proc "git" (c:args) 85 | 86 | git_ :: String -> [String] -> IO () 87 | git_ c args = 88 | cmd_ "git" (c:args) 89 | 90 | gitBool :: String -> [String] -> IO Bool 91 | gitBool c args = do 92 | (== ExitSuccess) <$> P.runProcess (git c args) 93 | 94 | removeTrailingNewline :: B.ByteString -> B.ByteString 95 | removeTrailingNewline "" = "" 96 | removeTrailingNewline bs = 97 | if B.last bs == '\n' 98 | then B.init bs 99 | else bs 100 | 101 | cmd :: String -> [String] -> IO String 102 | cmd c args = 103 | B.unpack . removeTrailingNewline <$> P.readProcessStdout_ (P.proc c args) 104 | 105 | cmd_ :: String -> [String] -> IO () 106 | cmd_ c args = P.runProcess_ $ P.proc c args 107 | 108 | cmdOut :: P.ProcessConfig () () () -> IO String 109 | cmdOut p = 110 | B.unpack . removeTrailingNewline <$> P.readProcessStdout_ p 111 | 112 | cmdMaybe :: P.ProcessConfig () () () -> IO (Maybe String) 113 | cmdMaybe p = do 114 | (ret, out ,_err) <- P.readProcess p 115 | return $ if ret == ExitSuccess 116 | then Just (B.unpack (removeTrailingNewline out)) 117 | else Nothing 118 | 119 | cmdLines :: P.ProcessConfig () () () -> IO [String] 120 | cmdLines p = 121 | map B.unpack . B.lines <$> P.readProcessStdout_ p 122 | 123 | -- from simple-cmd 124 | error' :: String -> a 125 | #if (defined(MIN_VERSION_base) && MIN_VERSION_base(4,9,0)) 126 | error' = errorWithoutStackTrace 127 | #else 128 | error' = error 129 | #endif 130 | 131 | tarGzExt :: String 132 | tarGzExt = "tar.gz" 133 | 134 | assertTagOnBranch :: String -> IO () 135 | assertTagOnBranch tag = 136 | whenM (null <$> cmdOut (git "branch" ["--contains", "tags/" ++ tag])) $ 137 | error' $ tag +-+ "is no longer on branch: use --force to move it" 138 | 139 | tagDistCmd :: Bool -> Bool -> Bool -> Bool -> IO () 140 | tagDistCmd existingtag force noHlint nobuild = do 141 | pkgid <- checkPackage True 142 | let tag = pkgidTag pkgid 143 | mtagHash <- cmdMaybe (git "rev-parse" [tag]) 144 | let tagexists = isJust mtagHash 145 | when (not force && tagexists) $ assertTagOnBranch tag 146 | if existingtag 147 | then if not tagexists 148 | then error' $ "tag" +-+ tag +-+ "does not exist" 149 | else sdist force noHlint nobuild pkgid 150 | else do 151 | if tagexists && not force 152 | then do 153 | headHash <- cmdOut (git "rev-parse" ["HEAD"]) 154 | let onHead = Just headHash == mtagHash 155 | putStrLn $ "tag is" +-+ (if onHead then "" else "not") +-+ "on HEAD" 156 | let tarball = sdistDir showPkgId pkgid <.> tarGzExt 157 | exists <- doesFileExist tarball 158 | if exists 159 | then error' $ "tag" +-+ tag +-+ "exists: use --force to" +-+ 160 | (if exists then "override tarball and" else "") +-+ "move" 161 | else sdist force noHlint nobuild pkgid 162 | else do 163 | git_ "tag" $ ["--force" | force] ++ [tag] 164 | unless force $ putStrLn tag 165 | -- actually always forced because: `== not (tagexists && not force)` 166 | sdist (force || not tagexists) noHlint nobuild pkgid 167 | `onException` do 168 | putStrLn "Resetting tag" 169 | if force 170 | then git_ "tag" ["--force", tag, fromJust mtagHash] 171 | else git_ "tag" ["--delete", tag] 172 | 173 | pkgidTag :: PackageIdentifier -> String 174 | pkgidTag pkgid = "v" ++ packageVersion pkgid 175 | 176 | checkPackage :: Bool -> IO PackageIdentifier 177 | checkPackage checkDiff = do 178 | when checkDiff $ do 179 | diff <- cmdOut $ git "diff" ["HEAD"] 180 | unless (null diff) $ do 181 | putStrLn "=== start of uncommitted changes ===" 182 | putStrLn diff 183 | putStrLn "=== end of uncommitted changes ===" 184 | pkgid <- getPackageId 185 | checkNameVersionCommitted pkgid 186 | checkNotPublished pkgid 187 | return pkgid 188 | where 189 | checkNameVersionCommitted :: PackageIdentifier -> IO () 190 | checkNameVersionCommitted pkgid = do 191 | let pkg = packageName pkgid 192 | cabalfile = unPackageName pkg <.> "cabal" 193 | unlessM (doesFileExist cabalfile) $ 194 | error' $ ".cabal filename differs from package name:" +-+ unPackageName pkg 195 | diff <- cmdOut (git "diff" ["-U0", "HEAD", cabalfile]) 196 | when (any ("+version:" `isPrefixOf`) (lines (map toLower diff))) $ 197 | error' "Please commit or revert the changed package Version first" 198 | 199 | checkNotPublished :: PackageIdentifier -> IO () 200 | checkNotPublished pkgid = do 201 | let published = sdistDir showPkgId pkgid <.> tarGzExt <.> "published" 202 | exists <- doesFileExist published 203 | when exists $ error' $ showPkgId pkgid +-+ "was already published!!" 204 | let oldpublished = "dist" showPkgId pkgid <.> tarGzExt <.> "published" 205 | oldExists <- doesFileExist oldpublished 206 | when oldExists $ error' $ showPkgId pkgid +-+ "was already published!!" 207 | 208 | sdistDir :: FilePath 209 | sdistDir = ".hkgr" 210 | 211 | sdist :: Bool -> Bool -> Bool -> PackageIdentifier -> IO () 212 | sdist force noHlint nobuild pkgid = do 213 | let tag = pkgidTag pkgid 214 | let target = sdistDir showPkgId pkgid <.> tarGzExt 215 | haveTarget <- doesFileExist target 216 | when haveTarget $ 217 | if force 218 | then removeFile target 219 | else error' $ target +-+ "exists already!" 220 | cwd <- getCurrentDirectory 221 | withTempDirectory "tmp-sdist" $ do 222 | git_ "clone" ["-q", "--no-checkout", "..", "."] 223 | git_ "checkout" ["-q", tag] 224 | whenM (doesFileExist ".gitmodules") $ 225 | git_ "submodule" ["update", "--init"] 226 | cabal_ "check" [] 227 | unless noHlint $ do 228 | mhlint <- findExecutable "hlint" 229 | when (isJust mhlint) $ do 230 | putStrLn "# Running hlint" 231 | void $ P.runProcess $ P.proc "hlint" ["--no-summary", "."] 232 | let dest = takeDirectory $ cwd target 233 | unlessM (doesDirectoryExist dest) $ 234 | createDirectoryIfMissing True dest 235 | addCabalProject 236 | cabal_ "v2-sdist" ["--output-dir=" ++ dest] 237 | unless nobuild pristineBuildCmd 238 | 239 | showVersionCmd :: IO () 240 | showVersionCmd = do 241 | pkgid <- getPackageId 242 | putStrLn $ packageVersion pkgid 243 | 244 | gitListTag :: String -> IO Bool 245 | gitListTag tag = do 246 | res <- cmdOut $ git "tag" ["--list", tag] 247 | return $ res == tag 248 | 249 | -- FIXME cabal install creates tarballs now 250 | uploadCmd :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> IO () 251 | uploadCmd publish existingtag force noHlint nobuild noupload = do 252 | needProgram "cabal" 253 | pkgid <- checkPackage False 254 | let tarball = sdistDir showPkgId pkgid <.> tarGzExt 255 | tag = pkgidTag pkgid 256 | tagexists <- gitListTag tag 257 | when (not tagexists && existingtag) $ 258 | error' $ tag +-+ "does not exist" 259 | when (force || not tagexists) $ 260 | tagDistCmd existingtag force noHlint nobuild 261 | assertTagOnBranch tag 262 | untagged <- cmdLines $ git "log" ["--pretty=reference", tag ++ "..HEAD"] 263 | unless (null untagged) $ do 264 | putStrLn $ "untagged newer commit" ++ 265 | (if length untagged > 1 then "s" else "") ++ ":" 266 | mapM_ putStrLn untagged 267 | when publish $ do 268 | tagHash <- cmdOut $ git "rev-parse" [tag] 269 | branch <- cmdOut $ git "branch" ["--show-current"] 270 | mergeable <- gitBool "merge-base" ["--is-ancestor", "HEAD", tagHash] 271 | when mergeable $ do 272 | putStr "git pushing... " 273 | git_ "push" ["--quiet", "origin", tagHash ++ ":" ++ branch] 274 | putStrLn "done" 275 | git_ "push" ["origin", tag] 276 | unless noupload $ do 277 | userpassBS <- getUserPassword 278 | -- FIXME if password fails, repeat login 279 | void $ P.readProcessInterleaved_ (P.setStdin (P.byteStringInput userpassBS) $ P.proc "cabal" ("upload" : ["--publish" | publish] ++ [tarball])) 280 | putStrLn $ (if publish then "Published at" else "Uploaded to") +-+ "https://hackage.haskell.org/package/" ++ showPkgId pkgid ++ if publish then "" else "/candidate" 281 | when publish $ 282 | createFileLink (takeFileName tarball) (tarball <.> "published") 283 | 284 | getUserPassword :: IO B.ByteString 285 | getUserPassword = do 286 | cabalConfig <- do 287 | home <- getHomeDirectory 288 | let cabalConfig = home ".cabal/config" 289 | exists <- doesFileExist cabalConfig 290 | if exists 291 | then readFile cabalConfig 292 | else do 293 | putStrLn $ "Warning:" +-+ cabalConfig +-+ "not found!" 294 | return "" 295 | muser <- maybeGetHackage "username" False cabalConfig 296 | mpasswd <- maybeGetHackage "password" True cabalConfig 297 | return $ B.pack $ unlines $ catMaybes [muser, mpasswd] 298 | where 299 | maybeGetHackage :: String -> Bool -> String -> IO (Maybe String) 300 | maybeGetHackage field hide cabalConfig = 301 | if haveCabalConfigField 302 | then return Nothing 303 | else Just <$> prompt hide ("hackage.haskell.org" +-+ field) 304 | where 305 | haveCabalConfigField :: Bool 306 | haveCabalConfigField = 307 | any ((field ++ ":") `isPrefixOf`) (lines cabalConfig) 308 | 309 | prompt :: Bool -> String -> IO String 310 | prompt hide s = do 311 | inp <- (if hide then promptPassword else promptNonEmpty) s 312 | when hide $ putChar '\n' 313 | return inp 314 | 315 | upHaddockCmd :: Bool -> Bool -> IO () 316 | upHaddockCmd publish force = do 317 | needProgram "cabal" 318 | userpassBS <- getUserPassword 319 | pkgid <- getPackageId 320 | when force $ do 321 | let tarball = "dist" showPkgId pkgid ++ '-' : "docs" <.> tarGzExt 322 | exists <- doesFileExist tarball 323 | when exists $ 324 | removeFile tarball 325 | _out <- P.readProcessInterleaved_ (P.setStdin (P.byteStringInput userpassBS) $ P.proc "cabal" ("upload" : "--documentation" : ["--publish" | publish])) 326 | putStrLn $ (if publish then "Published at" else "Uploaded to") +-+ "https://hackage.haskell.org/package/" ++ showPkgId pkgid ++ if publish then "" else "/candidate" 327 | 328 | cabal_ :: String -> [String] -> IO () 329 | cabal_ c args = 330 | cmd_ "cabal" (c:args) 331 | 332 | withTempDirectory :: FilePath -> IO a -> IO a 333 | withTempDirectory dir run = 334 | bracket_ (createDirectory dir) (removeDirectoryRecursive dir) $ 335 | withCurrentDirectory dir run 336 | 337 | -- #if (defined(MIN_VERSION_simple_cmd) && MIN_VERSION_simple_cmd(0,2,1)) 338 | -- #else 339 | needProgram :: String -> IO () 340 | needProgram prog = do 341 | mx <- findExecutable prog 342 | unless (isJust mx) $ error' $ "program needs" +-+ prog 343 | -- #endif 344 | 345 | -- FIXME warning if upstream template changed (keep a versioned template copy) 346 | -- FIXME add default templates dir 347 | newCmd :: Maybe String -> Maybe String -> IO () 348 | newCmd mlicense mproject = do 349 | needProgram "cabal" 350 | name <- case mproject of 351 | Just ns -> return ns 352 | Nothing -> do 353 | files <- listDirectory "." 354 | if null files then takeFileName <$> getCurrentDirectory 355 | else do 356 | -- filter out dirs 357 | dirs <- filterM doesDirectoryExist files 358 | if dirs == files then error' "Could not guess name: subdirectories found" 359 | else 360 | case filter ("cabal" `isExtensionOf`) $ files \\ dirs of 361 | [] -> takeFileName <$> getCurrentDirectory 362 | [cbl] -> return $ takeBaseName cbl 363 | _ -> error' "More than one .cabal file found!" 364 | when (isJust mproject) $ createDirectory name >> setCurrentDirectory name 365 | mcabal <- checkForCabalFile 366 | case mcabal of 367 | Nothing -> do 368 | let setupFile = "Setup.hs" 369 | origsetup <- doesFileExist setupFile 370 | cabalversion <- readVersion <$> cmd "cabal" ["--numeric-version"] 371 | let license = 372 | case mlicense of 373 | Just l -> l 374 | Nothing -> 375 | if cabalversion > makeVersion [3,4] 376 | then "BSD-3-Clause" 377 | else "BSD3" 378 | cabal_ "init" ["--quiet", "--no-comments", "--non-interactive", "--is-libandexe", "--cabal-version=1.18", "--license=" ++ license, "--package-name=" ++ name, "--version=0.1.0", "--dependency=base<5", "--source-dir=src"] 379 | whenJustM (cmdMaybe $ P.proc "find" ["-name", "Main.hs"]) $ \ file -> do 380 | sed ["1s/^module Main where/-- SPDX-License-Identifier:" +-+ license ++ "\\n\\nmodule Main (main) where/"] file 381 | unless (file == "src/Main.hs") $ renameFile file "src/Main.hs" 382 | whenM (doesFileExist "CHANGELOG.md") $ 383 | renameFile "CHANGELOG.md" "ChangeLog.md" 384 | unlessM (doesFileExist "README.md") $ 385 | writeFile "README.md" $ "#" +-+ name ++ "\n" 386 | unless origsetup $ do 387 | setup <- doesFileExist setupFile 388 | when setup $ removeFile setupFile 389 | setupCabalTemplate name license 390 | Just cblName -> 391 | when (cblName /= name) $ 392 | putStrLn $ "Warning:" +-+ cblName +-+ "different to" +-+ name 393 | haveStackCfg <- doesFileExist "stack.yaml" 394 | mstack <- findExecutable "stack" 395 | -- FIXME add stack.yaml template too 396 | when (not haveStackCfg && isJust mstack) $ do 397 | -- FIXME determine last lts automatically 398 | cmd_ "stack" ["init", "--verbosity", "warn", "--resolver", "lts-22"] 399 | sed ["/^#/d", "/^$/d"] "stack.yaml" 400 | haveGit <- doesDirectoryExist ".git" 401 | unless haveGit $ do 402 | git_ "init" ["-q"] 403 | git_ "add" [name <.> "cabal"] 404 | where 405 | checkForCabalFile :: IO (Maybe String) 406 | checkForCabalFile = do 407 | files <- listDirectory "." 408 | case filter ("cabal" `isExtensionOf`) files of 409 | [] -> return Nothing 410 | [cbl] -> return $ Just (takeBaseName cbl) 411 | _ -> error' "More than one .cabal file found!" 412 | 413 | setupCabalTemplate :: String -> String -> IO () 414 | setupCabalTemplate name license = do 415 | userTemplate <- getUserConfigFile "hkgr" "template.cabal" 416 | unlessM (doesFileExist userTemplate) $ do 417 | origTemplate <- getDataFileName "template.cabal.tmpl" 418 | createDirectoryIfMissing True $ takeDirectory userTemplate 419 | -- FIXME put a copy of the current template there too for reference 420 | copyFile origTemplate userTemplate 421 | username <- cmdOut $ git "config" ["--global", "user.name"] 422 | replaceHolder "NAME" username userTemplate 423 | usermail <- 424 | fromMaybeM (cmdOut $ git "config" ["--global", "user.email"]) $ 425 | cmdMaybe $ git "config" ["--global", "github.email"] 426 | replaceHolder "EMAIL" usermail userTemplate 427 | githubuser <- cmdOut $ git "config" ["--global", "github.user"] 428 | replaceHolder "USER" githubuser userTemplate 429 | putStrLn $ userTemplate +-+ "set up" 430 | copyFile userTemplate $ name <.> "cabal" 431 | replaceHolder "PROJECT" name $ name <.> "cabal" 432 | replaceHolder "PROJECT_" (map underscore name) $ name <.> "cabal" 433 | replaceHolder "SUMMARY" (name +-+ "project") $ name <.> "cabal" 434 | replaceHolder "LICENSE" license $ name <.> "cabal" 435 | year <- cmdOut (P.proc "date" ["+%Y"]) 436 | replaceHolder "YEAR" year $ name <.> "cabal" 437 | let modulePath = "src/MyLib.hs" 438 | unlessM (doesFileExist modulePath) $ do 439 | createDirectoryIfMissing True $ takeDirectory modulePath 440 | writeFile modulePath "-- SPDX-License-Identifier: BSD-3-Clause\n\nmodule MyLib where\n" 441 | where 442 | replaceHolder lbl val = 443 | sed ["s/@" ++ lbl ++ "@/" ++ val ++ "/"] 444 | 445 | underscore '-' = '_' 446 | underscore c = c 447 | 448 | sed :: [String] -> FilePath -> IO () 449 | sed [] _ = error' "sed given no script" 450 | sed args file = 451 | cmd_ "sed" $ ["-i", "-e"] ++ intersperse "-e" args ++ [file] 452 | 453 | #if !MIN_VERSION_filepath(1,4,2) 454 | isExtensionOf :: String -> FilePath -> Bool 455 | isExtensionOf ext@('.':_) = isSuffixOf ext . takeExtensions 456 | isExtensionOf ext = isSuffixOf ('.':ext) . takeExtensions 457 | #endif 458 | 459 | #if !MIN_VERSION_extra(1,6,15) 460 | fromMaybeM :: Monad m => m a -> m (Maybe a) -> m a 461 | fromMaybeM n = maybeM n return 462 | #endif 463 | 464 | -- FIXME rename github remote too? 465 | renameCmd :: String -> IO () 466 | renameCmd newname = do 467 | pkgid <- getPackageId 468 | let oldname = unPackageName (pkgName pkgid) 469 | sed ["s/" ++ oldname ++ "/" ++ newname ++ "/g", "s/Paths_" ++ replace "-" "_" oldname ++ "/Paths_" ++ replace "-" "_" newname ++ "/g"] $ oldname <.> "cabal" 470 | git_ "mv" [oldname <.> "cabal", newname <.> "cabal"] 471 | -- FIXME for all *.hs 472 | whenM (doesFileExist "src/Main.hs") $ 473 | sed ["s/" ++ oldname ++ "/" ++ newname ++ "/g", "s/Paths_" ++ replace "-" "_" oldname ++ "/Paths_" ++ replace "-" "_" newname ++ "/g"] "src/Main.hs" 474 | sed ["s/" ++ oldname ++ "/" ++ newname ++ "/g"] "README.md" 475 | sed ["s/" ++ oldname ++ "/" ++ newname ++ "/g"] "ChangeLog.md" 476 | renameDirectory (".." oldname) (".." newname) 477 | 478 | githubCmd :: IO () 479 | githubCmd = do 480 | ghuser <- cmdOut $ git "config" ["--global", "github.user"] 481 | pkgid <- getPackageId 482 | let name = unPackageName (pkgName pkgid) 483 | git_ "remote" ["add", "origin", "git@github.com:" ++ ghuser name <.> "git"] 484 | git_ "branch" ["-M", "main"] 485 | -- git_ "push" ["-u", "origin", "main"] 486 | 487 | -- pristine cabal sdist/build fail if there's a top cabal.project 488 | addCabalProject :: IO () 489 | addCabalProject = do 490 | let cabalproject = "cabal.project" 491 | unlessM (doesFileExist cabalproject) $ 492 | writeFile cabalproject "packages: .\n" 493 | 494 | pristineBuildCmd :: IO () 495 | pristineBuildCmd = do 496 | needProgram "cabal" 497 | pkgid <- getPackageId 498 | cwd <- getCurrentDirectory 499 | let tarball = cwd sdistDir showPkgId pkgid <.> tarGzExt 500 | exists <- doesFileExist tarball 501 | unless exists $ 502 | error' $ "Please 'tagdist' first:" +-+ tarball +-+ "not found" 503 | withTempDirectory "tmp-build" $ do 504 | cmd_ "tar" ["xf", tarball] 505 | setCurrentDirectory $ showPkgId pkgid 506 | addCabalProject 507 | putStrLn $ "cabal building" +-+ showPkgId pkgid <.> tarGzExt 508 | cabal_ "build" [] 509 | -------------------------------------------------------------------------------- /stack-lts13.yaml: -------------------------------------------------------------------------------- 1 | resolver: lts-13.30 2 | 3 | extra-deps: 4 | - simple-cmd-0.2.0 5 | - simple-cabal-0.1.0 6 | - simple-cmd-args-0.1.6 7 | - simple-prompt-0.2.0.1 8 | -------------------------------------------------------------------------------- /stack-lts14.yaml: -------------------------------------------------------------------------------- 1 | resolver: lts-14.27 2 | 3 | extra-deps: 4 | - simple-cmd-args-0.1.6 5 | - simple-prompt-0.2.0.1 6 | -------------------------------------------------------------------------------- /stack.yaml: -------------------------------------------------------------------------------- 1 | resolver: lts-20.26 2 | extra-deps: 3 | - simple-prompt-0.2.0.1 4 | --------------------------------------------------------------------------------