├── .github └── workflows │ └── release.yml ├── .gitignore ├── Gemfile ├── LICENCE ├── README.md ├── Rakefile ├── SECURITY.md ├── bin └── git-version-bump ├── git-version-bump.gemspec └── lib ├── git-version-bump.rb └── git-version-bump ├── rake-tasks.rb └── version.rb /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: "Release to RubyGems" 2 | on: 3 | push: 4 | branch: [main] 5 | release: 6 | types: [created] 7 | workflow_dispatch: 8 | 9 | jobs: 10 | upload: 11 | runs-on: ubuntu-latest 12 | name: "Upload gem" 13 | 14 | steps: 15 | - uses: actions/checkout@v2 16 | with: 17 | fetch-depth: 0 18 | 19 | - name: Install ruby 20 | uses: ruby/setup-ruby@v1 21 | with: 22 | ruby-version: '2.7' 23 | bundler-cache: true 24 | 25 | - name: Workaround for https://github.com/actions/checkout/issues/290 26 | run: | 27 | git fetch --force --tags 28 | 29 | - name: Do The Needful 30 | env: 31 | GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }} 32 | run: | 33 | bundle exec rake release:rubygem_push 34 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | pkg/ 2 | .bundle/ 3 | Gemfile.lock 4 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org/' 2 | 3 | gemspec 4 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 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 | Maintain your program versions entirely within git. No local files 2 | required! All versioning information is stored using git tags. 3 | 4 | This gem contains a command-line tool and set of Rake tasks to increment 5 | and display your version numbers via git tags, and some associated Ruby code to use 6 | inside a gemspec or your program to retrieve the current version number, for 7 | use in builds and at runtime. 8 | 9 | 10 | # Usage 11 | 12 | Most of your day-to-day usage of `git-version-bump` will be via the command 13 | line. When you bump a version, a new tag will be created representing the newly 14 | incremented version number at the current commit. If no tags currently 15 | exist, the previous version will be taken to be `0.0.0` and then incremented 16 | accordingly. 17 | 18 | 19 | ## On the command line 20 | 21 | Pretty damned trivial: 22 | 23 | git version-bump 24 | 25 | You can also shorten the specifier to any unique substring: 26 | 27 | git version-bump ma 28 | git version-bump mi 29 | git version-bump p 30 | git version-bump s 31 | 32 | I recommend adding an alias to your `~/.gitconfig` file, for less typing: 33 | 34 | [alias] 35 | vb = version-bump 36 | 37 | You can also add your own release notes to your release tags, by using the 38 | `-n` (or `--notes`, if you like typing) option: 39 | 40 | git version-bump -n minor 41 | 42 | This will open an editor, containing a list of the commits since the last 43 | release tag, in which you can type your release notes. If you follow 44 | standard git commit style (a "heading" line, then a blank line, followed by 45 | free-form text) you're perfectly positioned to use 46 | [github-release](http://theshed.hezmatt.org/github-release) to make 47 | gorgeous-looking release announcements to Github. 48 | 49 | 50 | ## In your `Rakefile` 51 | 52 | If you'd like to have access to the version-bumping goodness via `rake`, add 53 | the following line to your `Rakefile`: 54 | 55 | require 'git-version-bump/rake-tasks' 56 | 57 | You will now have the following rake tasks available: 58 | 59 | rake version:bump:major # bump major version (x.y.z -> x+1.0.0) 60 | rake version:bump:minor # bump minor version (x.y.z -> x.y+1.0) 61 | rake version:bump:patch # bump patch version (x.y.z -> x.y.z+1) 62 | rake version:bump:show # Print current version number 63 | 64 | (Since `version:bump:major` is a lot of typing, there are also shortcuts: 65 | `v:b:major`, `v:b:maj`, `v:b:minor`, `v:b:min`, `v:b:patch`, `v:b:pat`, and 66 | `v:b:p`) 67 | 68 | 69 | ## In your Ruby code 70 | 71 | To get access to this version information in your code (such as in your 72 | `gemspec`, or the definition of a `::VERSION` constant), you can `require 73 | 'git-version-bump'` and use the following methods: 74 | 75 | GVB.version # Return the entire version string 76 | GVB.major_version # Return just the 'major' portion of the version 77 | GVB.minor_version # Return just the 'minor' portion of the version 78 | GVB.patch_version # Return just the 'patch' portion of the version 79 | GVB.internal_revision # Return "internal revision" information, or nil 80 | GVB.date # Return the date of the most recent commit, or 81 | # today's date if the tree is dirty 82 | 83 | The "internal revision" is set when the tree is dirty, or when the latest 84 | git commit doesn't correspond with a tag. In that case, the internal 85 | revision will describe, in the manner of `git describe`, the full details of 86 | the version of the code in use. This information will be part of the 87 | version string provided by `gvb_version`. 88 | 89 | If any of these methods are called when there isn't a tag or other version 90 | information available, the version will be assumed to be `0.0.0.1.ENOTAG` 91 | with a date of `1970-01-01`. 92 | 93 | 94 | ### In your gemspec 95 | 96 | Typically, you want to encode your version and commit date into your 97 | gemspec, like this: 98 | 99 | Gem::Specification.new do |s| 100 | s.version = GVB.version 101 | s.date = GVB.date 102 | 103 | ... 104 | end 105 | 106 | The beauty of this method is that whenever you run a `rake build`, you'll 107 | get a gem which is *accurately* versioned for the current state of your 108 | repository. No more wondering if the `foobar-1.2.3` gem installed on your 109 | system was built from pristine sources, or with that experimental patch you 110 | were trying out... 111 | 112 | 113 | ### In your gem 114 | 115 | If, like me, you're one of those people who likes to be able to easily see 116 | what version of a library you're running, then you probably like to define a 117 | `VERSION` constant somewhere in your gem's namespace. That, too, is simple 118 | to do: 119 | 120 | require 'git-version-bump' 121 | 122 | class Foobar 123 | VERSION = GVB.version 124 | end 125 | 126 | This will work correctly inside your git tree, and also in your installed 127 | gem. Magical! 128 | 129 | #### For projects using lite tags 130 | 131 | If you are using GitHub releases for your project or some other method that 132 | involves light tags (tags with no annotations), you might notice that these 133 | tags are not detected by git-version-bump by default. If you want these 134 | commits to be detected then use the following configuration: 135 | 136 | require 'git-version-bump' 137 | 138 | class Foobar 139 | # First parameter is use_local_git, second is include_lite_tags 140 | VERSION = GVB.version(false, true) 141 | end 142 | 143 | 144 | ## Overriding the version 145 | 146 | In very rare circumstances, while running in a git repo, you may wish to explicitly set the version or date returned by `GVB.version` or `GVB.date`, respectively. 147 | This can be done by setting the repo's `versionBump.versionOverride` or `versionBump.dateOverride` config values, like so: 148 | 149 | ```bash 150 | git config versionBump.versionOverride 1.2.3 151 | git config versionBump.dateOverride 1970-01-01 152 | ``` 153 | 154 | Note that whatever you set those values to is used without validity checking; if you set it to something weird, you'll get weird results. 155 | 156 | 157 | # Contributing 158 | 159 | Send your pull requests to the [Github 160 | repo](https://github.com/mpalmer/git-version-bump), or send patches to 161 | `theshed+git-version-bump@hezmatt.org`. Bug reports can be sent to the same 162 | place, although I greatly prefer patches. 163 | 164 | 165 | # Licence 166 | 167 | Unless otherwise specified, all code in this repository is licenced under 168 | the terms of the GNU Public Licence, version 3, as published by the Free 169 | Software Foundation. The full terms of this licence can be found in the 170 | file LICENCE. 171 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | require 'bundler' 3 | 4 | Bundler::GemHelper.install_tasks 5 | 6 | require 'rdoc/task' 7 | 8 | Rake::RDocTask.new do |rd| 9 | rd.main = "README.md" 10 | rd.title = 'git-version-bump' 11 | rd.rdoc_files.include("README.md", "lib/**/*.rb") 12 | end 13 | 14 | task :release do 15 | sh "git push --follow-tags" 16 | sh "git release" 17 | end 18 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | Security updates will be made to the latest released version. 6 | 7 | ## Reporting a Vulnerability 8 | 9 | If you have found a vulnerability in this codebase, nice one! 10 | Please report it by creating [a new draft advisory](https://github.com/mpalmer/git-version-bump/security/advisories/new), and we'll take it from there. 11 | -------------------------------------------------------------------------------- /bin/git-version-bump: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | if ARGV[0].nil? or 4 | ARGV[0].empty? or 5 | (ARGV.length == 1 && (ARGV[0] == "-d" || ARGV[0] == "--dry-run")) or 6 | ARGV[0] == '-h' or 7 | ARGV[0] == '--help' 8 | $stderr.puts <<-EOF.gsub(/^\t\t/, '') 9 | Usage: git version-bump [-n|--notes] [-l|--lite-tags] [-d|--dry-run] 10 | 11 | 'major': x.y.z -> x+1.0.0 12 | 'minor': x.y.z -> x.y+1.0 13 | 'patch': x.y.z -> x.y.z+1 14 | 15 | 'show': Display the current GVB version 16 | 17 | -d, --dry-run: Calculate and return the bump value, but don't update git workspace or remote 18 | -n, --notes: Prompt for "release notes" to add to the release tag 19 | -l, --lite-tags: Include non-annotated git tags 20 | EOF 21 | end 22 | 23 | release_notes = ARGV.delete('-n') || ARGV.delete('--notes') 24 | dry_run = ARGV.delete('-d') || ARGV.delete('--dry-run') 25 | lite_tags = ARGV.delete('-l') || ARGV.delete('--lite-tags') 26 | 27 | if ARGV[0].nil? or ARGV[0].empty? 28 | exit 1 29 | elsif ARGV[0] == '-h' or ARGV[0] == '--help' 30 | exit 0 31 | end 32 | 33 | begin 34 | require 'git-version-bump' 35 | 36 | result = case ARGV[0].downcase 37 | when /^maj?o?r?$/ 38 | "#{GVB.major_version(true) + 1}.0.0" 39 | when /^min?o?r?$/ 40 | "#{GVB.major_version(true)}.#{GVB.minor_version(true)+1}.0" 41 | when /^pa?t?c?h?$/ 42 | "#{GVB.major_version(true)}.#{GVB.minor_version(true)}.#{GVB.patch_version(true)+1}" 43 | when /^sh?o?w?$/ 44 | puts GVB.version(true) 45 | exit 0 46 | else 47 | $stderr.puts "Unknown argument: #{ARGV[0]}. Try --help." 48 | exit 1 49 | end 50 | 51 | if dry_run 52 | puts result 53 | else 54 | unless GVB.tag_version result, release_notes, lite_tags 55 | exit 1 56 | end 57 | puts "Version is now #{GVB.version(true)}." 58 | end 59 | rescue GVB::VersionUnobtainable => ex 60 | $stderr.puts "Could not obtain version information. #{ex.message} (git available: #{GVB.git_available?.inspect})" 61 | exit 1 62 | rescue GVB::CommandFailure => ex 63 | $stderr.puts "#{ex.message} (exit status: #{ex.exitstatus})" 64 | $stderr.puts "command output was:" 65 | $stderr.puts "----8<----" 66 | $stderr.puts ex.output 67 | $stderr.puts "---->8----" 68 | exit 1 69 | end 70 | -------------------------------------------------------------------------------- /git-version-bump.gemspec: -------------------------------------------------------------------------------- 1 | lib = File.expand_path('../lib', __FILE__) 2 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 3 | require 'git-version-bump' 4 | 5 | Gem::Specification.new do |s| 6 | s.name = "git-version-bump" 7 | 8 | s.version = GVB.version 9 | s.date = GVB.date 10 | 11 | s.platform = Gem::Platform::RUBY 12 | s.required_ruby_version = ">= 2.1.0" 13 | 14 | s.homepage = "https://github.com/mpalmer/git-version-bump" 15 | s.summary = "Manage your app version entirely via git tags" 16 | s.authors = ["Matt Palmer"] 17 | 18 | s.extra_rdoc_files = ["README.md"] 19 | s.files = `git ls-files`.split("\n") 20 | s.executables = ["git-version-bump"] 21 | 22 | s.add_development_dependency 'github-release' 23 | s.add_development_dependency 'rake' 24 | s.add_development_dependency 'bundler' 25 | s.add_development_dependency 'rdoc' 26 | end 27 | -------------------------------------------------------------------------------- /lib/git-version-bump.rb: -------------------------------------------------------------------------------- 1 | require 'tempfile' 2 | require 'digest/sha1' 3 | require 'open3' 4 | require 'pathname' 5 | 6 | module GitVersionBump 7 | class VersionUnobtainable < StandardError; end 8 | class CommandFailure < StandardError 9 | attr_accessor :output, :exitstatus 10 | 11 | def initialize(m, output, exitstatus) 12 | super(m) 13 | @output, @exitstatus = output, exitstatus 14 | end 15 | end 16 | 17 | VERSION_TAG_GLOB = 'v[0-9]*.[0-9]*.*[0-9]' 18 | private_constant :VERSION_TAG_GLOB 19 | 20 | DEVNULL = Gem.win_platform? ? "NUL" : "/dev/null" 21 | private_constant :DEVNULL 22 | 23 | def self.version(use_local_dir=false, include_lite_tags=false) 24 | if use_local_dir 25 | repo_version(true, include_lite_tags) 26 | else 27 | gem_version || repo_version(false, include_lite_tags) 28 | end.tap { |v| p :GVB_VERSION, v if debug? } 29 | end 30 | 31 | def self.major_version(use_local_dir=false, include_lite_tags=false) 32 | ver = version(use_local_dir, include_lite_tags) 33 | v = ver.split('.')[0] 34 | 35 | unless v =~ /^[0-9]+$/ 36 | raise ArgumentError, 37 | "#{v} (part of #{ver.inspect}) is not a numeric version component. Abandon ship!" 38 | end 39 | 40 | return v.to_i 41 | end 42 | 43 | def self.minor_version(use_local_dir=false, include_lite_tags=false) 44 | ver = version(use_local_dir, include_lite_tags) 45 | v = ver.split('.')[1] 46 | 47 | unless v =~ /^[0-9]+$/ 48 | raise ArgumentError, 49 | "#{v} (part of #{ver.inspect}) is not a numeric version component. Abandon ship!" 50 | end 51 | 52 | return v.to_i 53 | end 54 | 55 | def self.patch_version(use_local_dir=false, include_lite_tags=false) 56 | ver = version(use_local_dir, include_lite_tags) 57 | v = ver.split('.')[2] 58 | 59 | unless v =~ /^[0-9]+$/ 60 | raise ArgumentError, 61 | "#{v} (part of #{ver.inspect}) is not a numeric version component. Abandon ship!" 62 | end 63 | 64 | return v.to_i 65 | end 66 | 67 | def self.internal_revision(use_local_dir=false, include_lite_tags=false) 68 | version(use_local_dir, include_lite_tags).split('.', 4)[3].to_s 69 | end 70 | 71 | def self.date(use_local_dir=false, include_lite_tags = false) 72 | if use_local_dir 73 | repo_date(true, include_lite_tags) 74 | else 75 | gem_date || repo_date(false, include_lite_tags) 76 | end 77 | end 78 | 79 | def self.tag_version(v, release_notes = false, include_lite_tags=false) 80 | if dirty_tree? 81 | puts "You have uncommitted files. Refusing to tag a dirty tree." 82 | return false 83 | end 84 | if release_notes 85 | log_file = Tempfile.new('gvb') 86 | 87 | begin 88 | # We need to find the tag before this one, so we can list all the commits 89 | # between the two. This is not a trivial operation. 90 | git_cmd = ["git", "describe", "--match=#{VERSION_TAG_GLOB}", "--always"] 91 | git_cmd << "--tags" if include_lite_tags 92 | 93 | prev_tag = run_command(git_cmd, "getting previous release tag").strip.gsub(/-\d+-g[0-9a-f]+$/, '') 94 | 95 | log_file.puts <<-EOF.gsub(/^\t\t\t\t\t/, '') 96 | 97 | 98 | 99 | # Write your release notes above. The first line should be the release name. 100 | # To help you remember what's in here, the commits since your last release 101 | # are listed below. This will become v#{v} 102 | # 103 | EOF 104 | log_file.puts run_command(["git", "log", "--no-show-signature", "--format=# %h %s", "#{prev_tag}..HEAD"], "getting commit range of release") 105 | 106 | log_file.close 107 | 108 | pre_hash = Digest::SHA1.hexdigest(File.read(log_file.path)) 109 | run_command(["git", "config", "-e", "-f", log_file.path], "editing release notes", false) 110 | if Digest::SHA1.hexdigest(File.read(log_file.path)) == pre_hash 111 | puts "Release notes not edited; not making release" 112 | log_file.unlink 113 | return 114 | end 115 | 116 | puts "Tagging version #{v}..." 117 | run_command(["git", "tag", "-a", "-F", log_file.path, "v#{v}"], "tagging release with annotations") 118 | ensure 119 | log_file.unlink 120 | end 121 | else 122 | # Crikey this is a lot simpler 123 | run_command(["git", "tag", "-a", "-m", "Version v#{v}", "v#{v}"], "tagging release") 124 | end 125 | 126 | run_command(["git", "push"], "pushing commits to the default remote repository") 127 | run_command(["git", "push", "--tags"], "pushing tags to the default remote repository") 128 | end 129 | 130 | # Calculate a version number based on the date of the most recent git commit. 131 | # 132 | # Return a version format string of the form `"0.YYYYMMDD.N"`, where 133 | # `YYYYMMDD` is the date of the "top-most" commit in the tree, and `N` is 134 | # the number of other commits also made on that date. 135 | # 136 | # This version format is not recommented for general use. It has benefit 137 | # only in situations where the principles of Semantic Versioning have no 138 | # real meaning, such as packages where there is little or no concept of 139 | # "backwards compatibility" (eg packages which only contain images and 140 | # other assets), or where the package can, for reasons outside that of 141 | # the package itself, never break backwards compatibility (definitions of 142 | # binary-packed structures shared amongst multiple systems). 143 | # 144 | # The format of this commit-date-based version format allows for a strictly 145 | # monotonically-increasing version number, aligned with the progression of the 146 | # underlying git commit log. 147 | # 148 | # One limitation of the format is that it doesn't deal with the issue of 149 | # package builds made from multiple divergent trees. Unlike 150 | # `git-describe`-based output, there is no "commit hash" identity 151 | # included in the version string. This is because of (ludicrous) 152 | # limitations of the Rubygems format definition -- the moment there's a 153 | # letter in the version number, the package is considered a "pre-release" 154 | # version. Since hashes are hex, we're boned. Sorry about that. Don't 155 | # make builds off a branch, basically. 156 | # 157 | def self.commit_date_version(use_local_dir = false) 158 | if use_local_dir 159 | commit_date_version_string(true) 160 | else 161 | gem_version || commit_date_version_string(false) 162 | end 163 | end 164 | 165 | def self.commit_date_version_string(use_local_dir = false) 166 | commit_dates = run_command(["git", "-C", git_dir(use_local_dir).to_s, "log", "--no-show-signature", "--format=%at"], "getting dates of all commits"). 167 | split("\n"). 168 | map { |l| Time.at(Integer(l)).strftime("%Y%m%d") } 169 | 170 | version_date = commit_dates.first 171 | commit_count = commit_dates.select { |d| d == version_date }.length - 1 172 | dirty_suffix = if dirty_tree? 173 | ".dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}" 174 | else 175 | "" 176 | end 177 | 178 | return "0.#{version_date}.#{commit_count}#{dirty_suffix}" 179 | rescue CommandFailure => ex 180 | p :GVB_CDVS_CMD_FAIL, ex.output if debug? 181 | if ex.output =~ /fatal: your current branch .* does not have any commits yet/ 182 | return "0.0.0.1.ENOCOMMITS" 183 | else 184 | raise VersionUnobtainable, "Could not get commit date-based version from git repository at #{git_dir(use_local_dir)}" 185 | end 186 | end 187 | 188 | def self.git_available? 189 | try_command(["git", "--version"]) 190 | end 191 | private_class_method :git_available? 192 | 193 | def self.dirty_tree?(dir='.') 194 | # Are we in a dirty, dirty tree? 195 | ! run_command(["git", "-C", dir.to_s, "status", "--porcelain"], "checking for tree cleanliness").empty? 196 | end 197 | private_class_method :dirty_tree? 198 | 199 | # Execute a command, specified as an array. 200 | # 201 | # On success, the full output of the command (stdout+stderr, interleaved) is returned unless capture_output is not true. 202 | # On error, a `CommandFailure` exception is raised. 203 | # 204 | def self.run_command(cmd, desc, capture_output = true) 205 | unless cmd.is_a?(Array) 206 | raise ArgumentError, "Must pass command line arguments in an array" 207 | end 208 | 209 | unless cmd.all? { |s| s.is_a?(String) } 210 | raise ArgumentError, "Command line arguments must be strings" 211 | end 212 | 213 | if debug? 214 | p :GVB_CMD, desc, cmd 215 | end 216 | 217 | if capture_output == true 218 | out, status = Open3.capture2e({"LC_MESSAGES" => "C"}, *cmd) 219 | else 220 | out = '(output not captured)' 221 | pid = spawn(*cmd) 222 | (retpid, status) = Process.wait2 pid 223 | end 224 | 225 | if status.exitstatus != 0 226 | raise CommandFailure.new("Failed while #{desc}", out, status.exitstatus) 227 | else 228 | out 229 | end 230 | end 231 | private_class_method :run_command 232 | 233 | # Execute a command, and return whether it succeeded or failed. 234 | # 235 | def self.try_command(cmd) 236 | begin 237 | run_command(cmd, "try_command") 238 | true 239 | rescue CommandFailure 240 | false 241 | end 242 | end 243 | private_class_method :try_command 244 | 245 | def self.run_git(git_args, desc, use_local_dir) 246 | run_command(["git", "-C", git_dir(use_local_dir).to_s] + git_args, desc) 247 | end 248 | private_class_method :run_git 249 | 250 | def self.caller_file 251 | # Who called us? Because this method gets called from other methods 252 | # within this file, we can't just look at Gem.location_of_caller, but 253 | # instead we need to parse the caller stack ourselves to find which 254 | # gem we're trying to version all over. 255 | Pathname( 256 | caller_locations. 257 | map(&:path). 258 | tap { |c| p :CALLER_LOCATIONS, c if debug? }. 259 | find { |l| l != __FILE__ } 260 | ).realpath rescue nil 261 | end 262 | private_class_method :caller_file 263 | 264 | def self.caller_gemspec 265 | cf = caller_file or return nil 266 | 267 | # Grovel through all the loaded gems to try and find the gem 268 | # that contains the caller's file. 269 | Gem.loaded_specs.values.each do |spec| 270 | # On Windows I have encountered gems that already have an absolute 271 | # path, verify that the path is relative before appending to it 272 | search_dirs = spec.require_paths.map do |path| 273 | if Pathname(path).absolute? 274 | path 275 | else 276 | File.join(spec.full_gem_path, path) 277 | end 278 | end 279 | search_dirs << File.join(spec.full_gem_path, spec.bindir) 280 | search_dirs.map! do |d| 281 | begin 282 | Pathname(d).realpath.to_s 283 | rescue Errno::ENOENT 284 | nil 285 | end 286 | end.compact! 287 | 288 | if search_dirs.find { |d| cf.to_s.index(d) == 0 } 289 | return spec 290 | end 291 | end 292 | 293 | if debug? 294 | p :GVB_NO_GEMSPEC, cf 295 | end 296 | 297 | nil 298 | end 299 | private_class_method :caller_gemspec 300 | 301 | def self.gem_version 302 | return nil if caller_gemspec.nil? 303 | 304 | caller_gemspec.version.to_s 305 | end 306 | private_class_method :gem_version 307 | 308 | def self.gem_date 309 | return nil if caller_gemspec.nil? 310 | return nil if caller_gemspec.date.nil? 311 | 312 | caller_gemspec.date.strftime("%F") 313 | end 314 | private_class_method :gem_version 315 | 316 | def self.repo_version(use_local_dir, include_lite_tags) 317 | begin 318 | run_git(["config", "versionBump.versionOverride"], "getting versionOverride", use_local_dir).chomp 319 | rescue CommandFailure => ex 320 | p :NO_OVERRIDE_VERSION, [ex.class, ex.message] if debug? 321 | repo_version_from_tag(use_local_dir, include_lite_tags) 322 | end 323 | end 324 | private_class_method :repo_version 325 | 326 | def self.repo_version_from_tag(use_local_dir, include_lite_tags) 327 | git_cmd = ["git", "-C", git_dir(use_local_dir).to_s, "describe", "--dirty=.1.dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}", "--match=#{VERSION_TAG_GLOB}"] 328 | git_cmd << "--tags" if include_lite_tags 329 | 330 | begin 331 | run_command(git_cmd, "getting current version descriptor"). 332 | strip. 333 | gsub(/^v/, ''). 334 | gsub('-', '.') 335 | rescue CommandFailure => ex 336 | p :GVB_REPO_VERSION_FAILURE, ex.output if debug? 337 | if ex.output =~ /fatal: No names found, cannot describe anything/ 338 | # aka "no tags, bro" 339 | "0.0.0.1.ENOTAG" 340 | else 341 | raise VersionUnobtainable, "Could not get version from gemspec or git repository at #{git_dir(use_local_dir)}" 342 | end 343 | end 344 | end 345 | private_class_method :repo_version_from_tag 346 | 347 | def self.repo_date(use_local_dir, include_lite_tags) 348 | begin 349 | run_git(["config", "versionBump.dateOverride"], "getting dateOverride", use_local_dir).chomp 350 | rescue CommandFailure => ex 351 | p :NO_OVERRIDE_DATE, [ex.class, ex.message] if debug? 352 | repo_date_from_commit(use_local_dir, include_lite_tags) 353 | end 354 | end 355 | private_class_method :repo_date 356 | 357 | def self.repo_date_from_commit(use_local_dir, include_lite_tags) 358 | if dirty_tree?(git_dir(use_local_dir)) 359 | Time.now.strftime("%F") 360 | else 361 | # Clean tree. Date of last commit is needed. 362 | (run_command(["git", "-C", git_dir(use_local_dir).to_s, "show", "--no-show-signature", "--format=format:%cd", "--date=short"], "getting date of last commit").lines.first || "").strip 363 | end 364 | rescue CommandFailure 365 | raise VersionUnobtainable, "Could not get commit date from git repository at #{git_dir(use_local_dir)}" 366 | end 367 | private_class_method :repo_date_from_commit 368 | 369 | def self.git_dir(use_local_dir = false) 370 | if use_local_dir 371 | Dir.pwd 372 | else 373 | (caller_file && caller_file.dirname) || Dir.pwd 374 | end.tap { |d| p :GVB_GIT_DIR, use_local_dir, d if debug? } 375 | end 376 | private_class_method :git_dir 377 | 378 | def self.debug? 379 | ENV.key?("GVB_DEBUG") 380 | end 381 | private_class_method :debug? 382 | end 383 | 384 | GVB = GitVersionBump unless defined? GVB 385 | 386 | require 'git-version-bump/version' 387 | -------------------------------------------------------------------------------- /lib/git-version-bump/rake-tasks.rb: -------------------------------------------------------------------------------- 1 | require 'git-version-bump' 2 | 3 | namespace :version do 4 | namespace :bump do 5 | desc "bump major version (x.y.z -> x+1.0.0)" 6 | task :major do 7 | GVB.tag_version "#{GVB.major_version + 1}.0.0" 8 | 9 | puts "Version is now #{GVB.version}" 10 | end 11 | 12 | desc "bump minor version (x.y.z -> x.y+1.0)" 13 | task :minor do 14 | GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version+1}.0" 15 | 16 | puts "Version is now #{GVB.version}" 17 | end 18 | 19 | desc "bump patch version (x.y.z -> x.y.z+1)" 20 | task :patch do 21 | GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version}.#{GVB.patch_version+1}" 22 | 23 | puts "Version is now #{GVB.version}" 24 | end 25 | 26 | desc "Print current version" 27 | task :show do 28 | puts GVB.version 29 | end 30 | end 31 | end 32 | 33 | namespace :v do 34 | namespace :b do 35 | task :major => "version:bump:major" 36 | task :maj => "version:bump:major" 37 | 38 | task :minor => "version:bump:minor" 39 | task :min => "version:bump:minor" 40 | 41 | task :patch => "version:bump:patch" 42 | task :pat => "version:bump:patch" 43 | task :p => "version:bump:patch" 44 | 45 | task :show => "version:bump:show" 46 | task :sh => "version:bump:show" 47 | task :s => "version:bump:show" 48 | end 49 | end 50 | -------------------------------------------------------------------------------- /lib/git-version-bump/version.rb: -------------------------------------------------------------------------------- 1 | module GitVersionBump 2 | def self.VERSION 3 | GVB.version 4 | end 5 | 6 | def self.MAJOR_VERSION 7 | GVB.major_version 8 | end 9 | 10 | def self.MINOR_VERSION 11 | GVB.minor_version 12 | end 13 | 14 | def self.PATCH_VERSION 15 | GVB.patch_version 16 | end 17 | 18 | def self.INTERNAL_REVISION 19 | GVB.internal_revision 20 | end 21 | 22 | def self.DATE 23 | GVB.date 24 | end 25 | 26 | def self.const_missing(c) 27 | if self.respond_to?(c) && c =~ /\A[A-Z_]+\z/ 28 | public_send c 29 | else 30 | super 31 | end 32 | end 33 | end 34 | --------------------------------------------------------------------------------