GitHub action for generating sequential build numbers based on Git tag. The build number is stored in your GitHub repository as a ref, it doesn't add any extra commits to your repository. Use in your workflow like so:
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Generate build number
uses: onyxmueller/build-tag-number@v1
with:
token: ${{secrets.github_token}}
- name: Print new build number
run: echo "Build number is $BUILD_NUMBER"
# Or, if you're on Windows: echo "Build number is ${env:BUILD_NUMBER}"After that runs the subsequent steps in your job will have the environment variable BUILD_NUMBER available. If you prefer to be more explicit you can use the output of the step, like so:
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Generate build number
id: buildnumber
uses: onyxmueller/build-tag-number@v1
with:
token: ${{secrets.github_token}}
# Now you can pass ${{ steps.buildnumber.outputs.build_number }} to the next steps.
- name: Another step as an example
uses: actions/hello-world-docker-action@v1
with:
who-to-greet: ${{ steps.buildnumber.outputs.build_number }}The GITHUB_TOKEN environment variable is defined by GitHub for you. See virtual environments for GitHub actions for more information.
For other steps in the same job, you can use the methods above, to get the build number in other jobs you need to use job outputs mechanism:
jobs:
job1:
runs-on: ubuntu-latest
outputs:
build_number: ${{ steps.buildnumber.outputs.build_number }}
steps:
- name: Generate build number
id: buildnumber
uses: onyxmueller/build-tag-number@v1
with:
token: ${{secrets.github_token}}
job2:
needs: job1
runs-on: ubuntu-latest
steps:
- name: Another step as an example
uses: actions/hello-world-docker-action@v1
with:
who-to-greet: ${{needs.job1.outputs.build_number}}If you're moving from another build system, you might want to start from some specific number. The build-number action simply uses a special tag name to store the build number, build-number-x, so you can just create and push a tag with the number you want to start on. E.g. do
git tag build-number-500
git push origin build-number-500
and then your next build number will be 501. The action will always delete older refs that start with build-number-, e.g. when it runs and finds build-number-500 it will create a new tag, build-number-501 and then delete build-number-500.
Sometimes you may have more than one project to build in one repository. For example, you may have a client and a server in the same GitHub repository that you would like to generate independent build numbers for. Another example is you have two Dockerfiles in one repo and you'd like to version each of the built images with their own numbers.
To do this, use the prefix key, like so:
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Generate build number
id: buildnumber
uses: onyxmueller/build-tag-number@v1
with:
token: ${{ secrets.github_token }}
prefix: clientThis will generate a git tag like client-build-number-1.
If you then do the same in another workflow and use prefix: server then you'll get a second build-number tag called server-build-number-1.
The build number generator is global, there's no concept of special build numbers for special branches unless handled manually with the prefix property. It's probably something you would just use on builds from your master branch. It's just one number that gets increased every time the action is run.
This Github Action is based on original work done by Einar Egilsson, which is no longer maintained. You can read more about the original version on his blog:
http://einaregilsson.com/a-github-action-for-generating-sequential-build-numbers/
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent