zyborg/gh-action-buildnum
Generates build numbers for Workflow runs, across a number of _scopes_ useful for build tracking and versioning.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| gist_token | GitHub OAuth/PAT token to be used for accessing Gist to store builder number state. The integrated GITHUB_TOKEN that is normally accessible during a Workflow does not include read/write permissions to associated Gists, therefore a separate token is needed. You can control which account is used to actually store the state by generating a token associated with the target account. | yes | — |
| repo_full_name | The name of the current repository, in `<OWNER>/<REPO-NAME>` format. This input is optional and is only used to override the default value which is pulled in from the running Workflow context. This value is used to compute a unique identifier for the Gist that will be used to store state for current and subsequent build numbers. Default is `$env:GITHUB_REPOSITORY`. | no | — |
| workflow_name | The name of the workflow to identify the build number with. This input is optional and is only used to override the default value which is pulled in from the running Workflow context. This value is used to compute a unique identifier for the Gist that will be used to store state for current and subsequent build numbers. Default is `$env:GITHUB_WORKFLOW`. | no | — |
| version_key | A unique identifer used to calculate a version-specific build number. | no | — |
| skip_bump | If true, this will skip bumping up the build numbers, and only pulls in the last values stored in the state Gist. | no | — |
| set_env | If true, this will export the resolved version numbers as environment variables for the current and future steps. | no | — |
Outputs
| name | description |
|---|---|
| global_build_number | Resolved build number for the repository or `global` scope. |
| workflow_build_number | Resolved build number for the Workflow scope. |
| version_build_number | Resolved build number for the Version scope. |