Adjust logic for calculating version #1481
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In most cases, `GITHUB_REF` is set to something that starts with `refs/*`. There is a bug where it's not set and when that happens, we get a bad release. The version calculation happens incorrectly and it uses the git commit hash for the version, but that does not work for an actual release. There are three scenarios when the version is calculated: - When publishing a builder - When publishing a buildpack - When running tests for publishing a builder (i.e. create-package) The first two happen on release, and should read the tag and parse out the semver number. The latter should not have a version so it will fallback to running git to obtain the git commit hash and use that for a version. We were previously trying to detect the case where the variable was unset or empty, but didn't have the logic right. This PR switches things so that we look to make sure `GITHUB_REF` starts with `refs/*`. I'm hoping this will be more reliable. Signed-off-by: Daniel Mikusa <[email protected]>
dmikusa
added
type:bug
pivotal-david-osullivan
approved these changes
Feb 14, 2024
pivotal-david-osullivan
pushed a commit
that referenced
this pull request
Feb 14, 2024
* Bump action versions Bump versions for: - docker/login-action - mheap/github-action-required-labels - peter-evans/create-pull-request Signed-off-by: Daniel Mikusa <[email protected]> * Adjust logic for calculating version (#1481) In most cases, `GITHUB_REF` is set to something that starts with `refs/*`. There is a bug where it's not set and when that happens, we get a bad release. The version calculation happens incorrectly and it uses the git commit hash for the version, but that does not work for an actual release. There are three scenarios when the version is calculated: - When publishing a builder - When publishing a buildpack - When running tests for publishing a builder (i.e. create-package) The first two happen on release, and should read the tag and parse out the semver number. The latter should not have a version so it will fallback to running git to obtain the git commit hash and use that for a version. We were previously trying to detect the case where the variable was unset or empty, but didn't have the logic right. This PR switches things so that we look to make sure `GITHUB_REF` starts with `refs/*`. I'm hoping this will be more reliable. Signed-off-by: Daniel Mikusa <[email protected]> --------- Signed-off-by: Daniel Mikusa <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
In most cases,
GITHUB_REFis set to something that starts withrefs/*. There is a bug where it's not set and when that happens, we get a bad release. The version calculation happens incorrectly and it uses the git commit hash for the version, but that does not work for an actual release.There are three scenarios when the version is calculated:
The first two happen on release, and should read the tag and parse out the semver number. The latter should not have a version so it will fallback to running git to obtain the git commit hash and use that for a version.
We were previously trying to detect the case where the variable was unset or empty, but didn't have the logic right. This PR switches things so that we look to make sure
GITHUB_REFstarts withrefs/*. I'm hoping this will be more reliable.Resolves #1249