hashicorp/actions-set-product-version
1
0
Fork 0
mirror of https://github.com/hashicorp/actions-set-product-version synced 2026-04-05 19:06:17 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
37 commits 10 branches 4 tags 108 KiB
Find a file
Exact
Jeanne Franco 0e94332736
 Merge pull request #56 from hashicorp/compliance/update-headers 
[IND-4227] [COMPLIANCE] Update Copyright Headers
2026-01-05 15:50:21 -08:00
.github chore(gh-actions): update super linter action to v6.3.0 (#39) 2025-09-16 15:02:22 -07:00
META.d [COMPLIANCE] Update Copyright and License Headers 2025-12-09 10:14:23 +00:00
.gitignore Update the project metadata to resolve a number of Heimdall checks: (#36) 2023-06-20 11:05:07 -05:00
action.yml [COMPLIANCE] Update Copyright and License Headers 2025-12-09 10:14:23 +00:00
CODEOWNERS Update CODEOWNERS for SMRE (#41) 2024-04-26 13:06:54 -07:00
LICENSE [COMPLIANCE] Update Copyright and License Headers 2025-12-09 10:14:23 +00:00
README.md Update the project metadata to resolve a number of Heimdall checks: (#36) 2023-06-20 11:05:07 -05:00

README.md

actions-set-product-version

Heimdall CI

Description

actions-set-product-version is a Github action that acts as a bridge between the product repo and our new CRT feature: automated version bumping. This action should be used in the build.yml to parse the version/VERSION file that lives in all product repos.

THe following describes what this action does:

  • Allows for the static version string from the version/VERSION file to be read by the new CRT workflow and automagically be bumped to the next version (whether it be a minor, or patch, or major version bump).
  • Outputs an error if there’s no VERSION file in the version/ dir
  • Outputs an error if there’s no version string in the VERSION file
  • Is able to parse product_version if it is 1.3.0-alpha1 as 1.3.0 (example: when product_version = 1.3.0-alpha1, base_version = 1.3.0)
  • Is able to parse prerelease product versions such as alpha1 (example prerelease_product_version = alpha1) in the statement above.

Outputs

Note that the version/VERSION version should never contain metadata - only release version and prerelease information. This action has three outputs from parsing the release/prerelease information:

  • product-version (full product version string: eg. 1.0.0-dev)
  • base-product-version (product version stripped of prerelease information: eg. 1.0.0)
  • prerelease-product-version (prerelease information dev)

Use

This action should be implemented in product repo build.yml files. The action is intended to grab the version from the version file at the beginning of the build, then passes those versions (along with metadata, where necessary) to any workflow jobs that need version information.