├── .gitignore ├── LICENSE ├── README.md ├── go.mod ├── go.sum └── main.go /.gitignore: -------------------------------------------------------------------------------- 1 | /git-buildnumber* 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2013-2024 Kenneth Shaw 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # About git-buildnumber 2 | 3 | `git-buildnumber` produces versions strings for Git repositories in a `W.X.Y.Z` 4 | format, such that: 5 | 6 | ```txt 7 | W - Number of years since the start of the repo 8 | X - Month of year of a git commit 9 | Y - Day of the month of a git commit 10 | Z - Order (the number) of the git commit that day 11 | ``` 12 | 13 | By default, `git-buildnumber` calculates `W` as the number of calendar years 14 | since the repo's initial commit, but can be changed via a command-line option 15 | (see below). 16 | 17 | ### Use-case 18 | 19 | `git-buildnumber` produces standardized version strings in a human-readable 20 | form for use with rolling release cycles, or when a lexicographically-ordered 21 | build number is desirable. Version strings generated by `git-buildnumber` are not 22 | meant as a replacement for standard short/long Git commit hashes. 23 | 24 | ## Installing 25 | 26 | Install in the usual [Go][go-project] way: 27 | 28 | ```sh 29 | $ go get -u github.com/brankas/git-buildnumber 30 | ``` 31 | 32 | ## Using 33 | 34 | The following examples are for the `HEAD` of a Git repo created in 2014, and 35 | where the latest commit (ie, the 0th) was made on March 3rd, 2015: 36 | 37 | ```sh 38 | # general (from within the git worktree) 39 | $ cd /path/to/repo 40 | $ git-buildnumber 41 | v1.2.3.0 42 | 43 | # specify path to repo 44 | $ git-buildnumber /path/to/repo 45 | v1.2.3.0 46 | 47 | # short form (trims last ".0") 48 | $ git-buildnumber -short 49 | v1.2.3 50 | 51 | # use 2000 as year offset 52 | $ git-buildnumber -year 2000 53 | v15.2.3.0 54 | 55 | # use 2015 as year offset 56 | $ git-buildnumber -year 2015 57 | v0.2.3.0 58 | 59 | # short form and 2000 as year offset 60 | $ git-buildnumber -short -year 2000 61 | v15.2.3 62 | 63 | # short form and 0 as year offset 64 | $ git-buildnumber -short -year 0 65 | v2015.2.3 66 | 67 | # inverse 68 | $ git-buildnumber -inverse v1.2.3.0 69 | a3efd74543d3402b62184081ed93bfdf2c65421d 70 | ``` 71 | 72 | ### Command-line parameters 73 | 74 | ```sh 75 | Usage of git-buildnumber: 76 | -inverse string 77 | string to inverse 78 | -prefix string 79 | prefix (default "v") 80 | -rev string 81 | git revision (default "HEAD") 82 | -sep string 83 | field separator (default ".") 84 | -short 85 | trim last "0" from version 86 | -year string 87 | start year offset 88 | ``` 89 | 90 | **Note**: when `-year` is not specified, then an attempt is made to use the 91 | year of the first commit in the repository. If the year cannot be determined, 92 | then no offset calculation will be performed. 93 | 94 | [go-project]: https://golang.org/project/ 95 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/kenshaw/git-buildnumber 2 | 3 | go 1.21 4 | 5 | require ( 6 | github.com/go-git/go-git/v5 v5.12.0 7 | github.com/mattn/go-isatty v0.0.20 8 | ) 9 | 10 | require ( 11 | dario.cat/mergo v1.0.0 // indirect 12 | github.com/Microsoft/go-winio v0.6.2 // indirect 13 | github.com/ProtonMail/go-crypto v1.0.0 // indirect 14 | github.com/cloudflare/circl v1.3.8 // indirect 15 | github.com/cyphar/filepath-securejoin v0.2.5 // indirect 16 | github.com/emirpasic/gods v1.18.1 // indirect 17 | github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect 18 | github.com/go-git/go-billy/v5 v5.5.0 // indirect 19 | github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect 20 | github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect 21 | github.com/kevinburke/ssh_config v1.2.0 // indirect 22 | github.com/pjbgf/sha1cd v0.3.0 // indirect 23 | github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect 24 | github.com/skeema/knownhosts v1.2.2 // indirect 25 | github.com/xanzy/ssh-agent v0.3.3 // indirect 26 | golang.org/x/crypto v0.24.0 // indirect 27 | golang.org/x/net v0.26.0 // indirect 28 | golang.org/x/sys v0.21.0 // indirect 29 | gopkg.in/warnings.v0 v0.1.2 // indirect 30 | ) 31 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | dario.cat/mergo v1.0.0 h1:AGCNq9Evsj31mOgNPcLyXc+4PNABt905YmuqPYYpBWk= 2 | dario.cat/mergo v1.0.0/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk= 3 | github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= 4 | github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= 5 | github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= 6 | github.com/ProtonMail/go-crypto v1.0.0 h1:LRuvITjQWX+WIfr930YHG2HNfjR1uOfyf5vE0kC2U78= 7 | github.com/ProtonMail/go-crypto v1.0.0/go.mod h1:EjAoLdwvbIOoOQr3ihjnSoLZRtE8azugULFRteWMNc0= 8 | github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= 9 | github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= 10 | github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= 11 | github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= 12 | github.com/bwesterb/go-ristretto v1.2.3/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0= 13 | github.com/cloudflare/circl v1.3.3/go.mod h1:5XYMA4rFBvNIrhs50XuiBJ15vF2pZn4nnUKZrLbUZFA= 14 | github.com/cloudflare/circl v1.3.8 h1:j+V8jJt09PoeMFIu2uh5JUyEaIHTXVOHslFoLNAKqwI= 15 | github.com/cloudflare/circl v1.3.8/go.mod h1:PDRU+oXvdD7KCtgKxW95M5Z8BpSCJXQORiZFnBQS5QU= 16 | github.com/cyphar/filepath-securejoin v0.2.5 h1:6iR5tXJ/e6tJZzzdMc1km3Sa7RRIVBKAK32O2s7AYfo= 17 | github.com/cyphar/filepath-securejoin v0.2.5/go.mod h1:aPGpWjXOXUn2NCNjFvBE6aRxGGx79pTxQpKOJNYHHl4= 18 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 19 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 20 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 21 | github.com/elazarl/goproxy v0.0.0-20230808193330-2592e75ae04a h1:mATvB/9r/3gvcejNsXKSkQ6lcIaNec2nyfOdlTBR2lU= 22 | github.com/elazarl/goproxy v0.0.0-20230808193330-2592e75ae04a/go.mod h1:Ro8st/ElPeALwNFlcTpWmkr6IoMFfkjXAvTHpevnDsM= 23 | github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= 24 | github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= 25 | github.com/gliderlabs/ssh v0.3.7 h1:iV3Bqi942d9huXnzEF2Mt+CY9gLu8DNM4Obd+8bODRE= 26 | github.com/gliderlabs/ssh v0.3.7/go.mod h1:zpHEXBstFnQYtGnB8k8kQLol82umzn/2/snG7alWVD8= 27 | github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= 28 | github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= 29 | github.com/go-git/go-billy/v5 v5.5.0 h1:yEY4yhzCDuMGSv83oGxiBotRzhwhNr8VZyphhiu+mTU= 30 | github.com/go-git/go-billy/v5 v5.5.0/go.mod h1:hmexnoNsr2SJU1Ju67OaNz5ASJY3+sHgFRpCtpDCKow= 31 | github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= 32 | github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= 33 | github.com/go-git/go-git/v5 v5.12.0 h1:7Md+ndsjrzZxbddRDZjF14qK+NN56sy6wkqaVrjZtys= 34 | github.com/go-git/go-git/v5 v5.12.0/go.mod h1:FTM9VKtnI2m65hNI/TenDDDnUf2Q9FHnXYjuz9i5OEY= 35 | github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da h1:oI5xCqsCo564l8iNU+DwB5epxmsaqB+rhGL0m5jtYqE= 36 | github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= 37 | github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= 38 | github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= 39 | github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= 40 | github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= 41 | github.com/kevinburke/ssh_config v1.2.0 h1:x584FjTGwHzMwvHx18PXxbBVzfnxogHaAReU4gf13a4= 42 | github.com/kevinburke/ssh_config v1.2.0/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM= 43 | github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= 44 | github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= 45 | github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= 46 | github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= 47 | github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= 48 | github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= 49 | github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= 50 | github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= 51 | github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= 52 | github.com/onsi/gomega v1.27.10 h1:naR28SdDFlqrG6kScpT8VWpu1xWY5nJRCF3XaYyBjhI= 53 | github.com/onsi/gomega v1.27.10/go.mod h1:RsS8tutOdbdgzbPtzzATp12yT7kM5I5aElG3evPbQ0M= 54 | github.com/pjbgf/sha1cd v0.3.0 h1:4D5XXmUUBUl/xQ6IjCkEAbqXskkq/4O7LmGn0AqMDs4= 55 | github.com/pjbgf/sha1cd v0.3.0/go.mod h1:nZ1rrWOcGJ5uZgEEVL1VUM9iRQiZvWdbZjkKyFzPPsI= 56 | github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= 57 | github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= 58 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 59 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 60 | github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M= 61 | github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA= 62 | github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 h1:n661drycOFuPLCN3Uc8sB6B/s6Z4t2xvBgU1htSHuq8= 63 | github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= 64 | github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= 65 | github.com/skeema/knownhosts v1.2.2 h1:Iug2P4fLmDw9f41PB6thxUkNUkJzB5i+1/exaj40L3A= 66 | github.com/skeema/knownhosts v1.2.2/go.mod h1:xYbVRSPxqBZFrdmDyMmsOs+uX1UZC3nTN3ThzgDxUwo= 67 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 68 | github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= 69 | github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= 70 | github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= 71 | github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= 72 | github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= 73 | github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= 74 | github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= 75 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= 76 | golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= 77 | golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= 78 | golang.org/x/crypto v0.3.1-0.20221117191849-2c476679df9a/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4= 79 | golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU= 80 | golang.org/x/crypto v0.24.0 h1:mnl8DM0o513X8fdIkmyFE/5hTYxbwYOjDS/+rK6qpRI= 81 | golang.org/x/crypto v0.24.0/go.mod h1:Z1PMYSOR5nyMcyAVAIQSKCDwalqy85Aqn1x3Ws4L5DM= 82 | golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= 83 | golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= 84 | golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= 85 | golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= 86 | golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= 87 | golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= 88 | golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY= 89 | golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= 90 | golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc= 91 | golang.org/x/net v0.26.0 h1:soB7SVo0PWrY4vPW/+ay0jKDNScG2X9wFeYlXIvJsOQ= 92 | golang.org/x/net v0.26.0/go.mod h1:5YKkiSynbBIh3p6iOc/vibscux0x38BZDkn8sCUPxHE= 93 | golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 94 | golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 95 | golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 96 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 97 | golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 98 | golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 99 | golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 100 | golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 101 | golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 102 | golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 103 | golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 104 | golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 105 | golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 106 | golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 107 | golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 108 | golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 109 | golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws= 110 | golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= 111 | golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= 112 | golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= 113 | golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= 114 | golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= 115 | golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U= 116 | golang.org/x/term v0.21.0 h1:WVXCp+/EBEHOj53Rvu+7KiT/iElMrO8ACK16SMZ3jaA= 117 | golang.org/x/term v0.21.0/go.mod h1:ooXLefLobQVslOqselCNF4SxFAaoS6KujMbsGzSDmX0= 118 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 119 | golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 120 | golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 121 | golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= 122 | golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= 123 | golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= 124 | golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= 125 | golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4= 126 | golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI= 127 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= 128 | golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= 129 | golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= 130 | golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= 131 | golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= 132 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 133 | gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 134 | gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= 135 | gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= 136 | gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= 137 | gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= 138 | gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= 139 | gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= 140 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 141 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 142 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "errors" 5 | "flag" 6 | "fmt" 7 | "io" 8 | "os" 9 | "strconv" 10 | "strings" 11 | "time" 12 | 13 | git "github.com/go-git/go-git/v5" 14 | "github.com/go-git/go-git/v5/plumbing" 15 | "github.com/go-git/go-git/v5/plumbing/object" 16 | isatty "github.com/mattn/go-isatty" 17 | ) 18 | 19 | func main() { 20 | rev := flag.String("rev", "HEAD", "git revision") 21 | year := flag.String("year", "", "start year offset") 22 | prefix := flag.String("prefix", "v", "prefix") 23 | sep := flag.String("sep", ".", "field separator") 24 | short := flag.Bool("short", false, "trim last \"0\" from version") 25 | inverse := flag.String("inverse", "", "string to inverse") 26 | flag.Parse() 27 | if err := run(*rev, *year, *prefix, *sep, *short, *inverse); err != nil { 28 | fmt.Fprintf(os.Stderr, "error: %v\n", err) 29 | os.Exit(1) 30 | } 31 | } 32 | 33 | func run(rev, year, prefix, sep string, short bool, inverse string) error { 34 | var err error 35 | var wd string 36 | switch { 37 | case flag.NArg() == 0: 38 | wd, err = os.Getwd() 39 | if err != nil { 40 | return err 41 | } 42 | case flag.NArg() == 1: 43 | wd = os.Args[len(os.Args)-1] 44 | case flag.NArg() > 1: 45 | return errors.New("cannot specify more than one git directory") 46 | } 47 | // determine line end 48 | var extra string 49 | if isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd()) { 50 | extra = "\n" 51 | } 52 | openOpt := &git.PlainOpenOptions{DetectDotGit: true} 53 | repo, err := git.PlainOpenWithOptions(wd, openOpt) 54 | if err != nil { 55 | return err 56 | } 57 | if inverse == "" { 58 | var vers []string 59 | if vers, err = getVersion(repo, year, rev); err != nil { 60 | return err 61 | } 62 | if n := len(vers) - 1; short && vers[n] == "0" { 63 | vers = vers[:n] 64 | } 65 | fmt.Fprint(os.Stdout, prefix, strings.Join(vers, sep), extra) 66 | } else { 67 | var hash string 68 | if hash, err = getInverse(repo, year, sep, prefix, inverse); err != nil { 69 | return err 70 | } 71 | fmt.Fprint(os.Stdout, hash, extra) 72 | } 73 | return nil 74 | } 75 | 76 | // getVersion determines the version. 77 | func getVersion(repo *git.Repository, year, rev string) ([]string, error) { 78 | // find commit 79 | var commit *object.Commit 80 | hash, err := repo.ResolveRevision(plumbing.Revision(rev)) 81 | if err != nil { 82 | // could not resolve rev, so search for associated object 83 | if h := plumbing.NewHash(rev); h != plumbing.ZeroHash { 84 | var obj object.Object 85 | if obj, err = repo.Object(plumbing.AnyObject, h); err != nil { 86 | return nil, errors.New("invalid ref") 87 | } 88 | var ok bool 89 | if commit, ok = obj.(*object.Commit); !ok { 90 | return nil, errors.New("ref is not a commit ref") 91 | } 92 | } 93 | } else { 94 | // rev flag was blank or was valid gitrev 95 | commit, err = repo.CommitObject(*hash) 96 | if err != nil { 97 | return nil, err 98 | } 99 | } 100 | // empty repository 101 | if commit == nil { 102 | return []string{"0", "0", "0", "0"}, nil 103 | } 104 | // determine year offset 105 | offset, err := determineYearOffset(commit, year) 106 | if err != nil { 107 | return nil, err 108 | } 109 | // clamp date to UTC and year to 0 110 | date := commit.Committer.When.UTC() 111 | offset = date.Year() - offset 112 | if offset < 0 { 113 | offset = 0 114 | } 115 | // determine order 116 | order, err := commitOrder(commit, date.Truncate(24*time.Hour)) 117 | if err != nil { 118 | return nil, err 119 | } 120 | return []string{ 121 | strconv.Itoa(offset), 122 | strconv.Itoa(int(date.Month())), 123 | strconv.Itoa(date.Day()), 124 | strconv.Itoa(order), 125 | }, nil 126 | } 127 | 128 | // getInverse determines the hash based on the supplied flags. 129 | func getInverse(repo *git.Repository, year, sep, prefix, inverse string) (string, error) { 130 | // get head 131 | head, err := repo.Head() 132 | if err != nil { 133 | return "", err 134 | } 135 | // get commit 136 | commit, err := repo.CommitObject(head.Hash()) 137 | if err != nil { 138 | return "", err 139 | } 140 | // parse inverse string 141 | offset, month, day, order, err := parseInverse(commit, year, sep, prefix, inverse) 142 | if err != nil { 143 | return "", err 144 | } 145 | iter := object.NewCommitPostorderIter(commit, nil) 146 | defer iter.Close() 147 | // find closest matching commit 148 | var c *object.Commit 149 | for c, err = iter.Next(); err == nil; c, err = iter.Next() { 150 | d := c.Committer.When.UTC() 151 | var n int 152 | n, err = commitOrder(c, d.Truncate(24*time.Hour)) 153 | if err != nil { 154 | return "", err 155 | } 156 | if d.Year() == offset && d.Month() == month && d.Day() == day && order == n { 157 | return c.Hash.String(), nil 158 | } 159 | } 160 | if err != nil && err != io.EOF { 161 | return "", err 162 | } 163 | return "", errors.New("could not find matching version") 164 | } 165 | 166 | // parseInverse parses the inverse flag. 167 | func parseInverse(commit *object.Commit, year, prefix, sep, inverse string) (int, time.Month, int, int, error) { 168 | vers := strings.Split(strings.TrimPrefix(inverse, prefix), sep) 169 | if len(vers) == 3 { 170 | vers = append(vers, "0") 171 | } 172 | ver := make([]int, 4) 173 | var err error 174 | for i := range vers { 175 | ver[i], err = strconv.Atoi(vers[i]) 176 | if err != nil { 177 | return 0, 0, 0, 0, errors.New("invalid inverse version") 178 | } 179 | } 180 | // determine year offset 181 | var offset int 182 | offset, err = determineYearOffset(commit, year) 183 | if err != nil { 184 | return 0, 0, 0, 0, err 185 | } 186 | return ver[0] + offset, time.Month(ver[1]), ver[2], ver[3], nil 187 | } 188 | 189 | // determineYearOffset determines the offset for the given commit. 190 | func determineYearOffset(commit *object.Commit, year string) (int, error) { 191 | var err error 192 | var offset int 193 | if year != "" { 194 | if offset, err = strconv.Atoi(year); err != nil { 195 | return 0, err 196 | } 197 | } else { 198 | var oldest *object.Commit 199 | if oldest, err = oldestParent(commit); err != nil { 200 | return 0, err 201 | } 202 | offset = oldest.Committer.When.UTC().Year() 203 | } 204 | return offset, nil 205 | } 206 | 207 | // oldestParent retrieves the oldest parent of commit. 208 | func oldestParent(commit *object.Commit) (*object.Commit, error) { 209 | iter := object.NewCommitPostorderIter(commit, nil) 210 | defer iter.Close() 211 | 212 | oldest, date := commit, commit.Committer.When.UTC() 213 | var c *object.Commit 214 | var err error 215 | for c, err = iter.Next(); err == nil; c, err = iter.Next() { 216 | if len(c.ParentHashes) > 0 { 217 | continue 218 | } 219 | if d := c.Committer.When.UTC(); d.Before(date) { 220 | oldest, date = c, d 221 | } 222 | } 223 | if err != nil && err != io.EOF { 224 | return nil, err 225 | } 226 | return oldest, nil 227 | } 228 | 229 | // commitOrder determines the order (ie, number) of commits made before the 230 | // commit on the same date (based on UTC time). 231 | // 232 | // Note: zero ordered. 233 | func commitOrder(commit *object.Commit, date time.Time) (int, error) { 234 | iter := object.NewCommitIterCTime(commit, nil, nil) 235 | defer iter.Close() 236 | var count int 237 | var c *object.Commit 238 | var err error 239 | for c, err = iter.Next(); err == nil; c, err = iter.Next() { 240 | if d := c.Committer.When.UTC(); d.Equal(date) || d.After(date) { 241 | count++ 242 | } else { 243 | // Since we're iterating backwads by decreasing commit 244 | // time (like git log), stop when done. This allows us 245 | // to better support shallow clones. 246 | break 247 | } 248 | } 249 | if err != nil && err != io.EOF { 250 | return -1, err 251 | } 252 | return count - 1, nil 253 | } 254 | --------------------------------------------------------------------------------