build: snapshot builds incorrectly modify semver versions #20053
Conversation
This file contains hidden or 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
devversion
added
P3
googlebot
added
the
cla: yes
devversion
force-pushed
the
build/fix-version-stamping-snapshot
branch
from
bb2093a to
ef43741
Compare
josephperrott
approved these changes
Jul 21, 2020
An interesting case that came up in v10.0.0 with the docs-content. The snapshot release package and docs-content output had various `@breaking-change` notes in the source code referring to `v10.0.0` as certain changes are planned to be made at that point. The snapshot deploy scripts pick up the version from the package.json file and replace it in the output packages with a more concrete version that includes the SHA. This meant that we accidentally also overwrote versions as in the `@breaking-change` notes (ultimately making it difficult for us to use the latest docs-content for the v10 release as it was incorrect). Example snapshot commit: angular/material2-docs-content@e624c71 We fix this by not including the SHA as part of the deployment, but rather including the SHA when building the NPM packages. At that point, we can safely just replace instances of the `0.0.0-PLACEHOLDER` without having to worry about accidental version overriding. To achieve this, we update our release stamping script to have two modes. i.e. snapshot build mode and release mode. Framework does this by checking the Git tag history but that seems less ideal as it makes the release output building reliant on external factors while our stamping is self-contained within the checked out code revision.
devversion
force-pushed
the
build/fix-version-stamping-snapshot
branch
from
ef43741 to
a558cf1
Compare
wagnermaciel
pushed a commit
that referenced
this pull request
Jul 22, 2020
An interesting case that came up in v10.0.0 with the docs-content. The snapshot release package and docs-content output had various `@breaking-change` notes in the source code referring to `v10.0.0` as certain changes are planned to be made at that point. The snapshot deploy scripts pick up the version from the package.json file and replace it in the output packages with a more concrete version that includes the SHA. This meant that we accidentally also overwrote versions as in the `@breaking-change` notes (ultimately making it difficult for us to use the latest docs-content for the v10 release as it was incorrect). Example snapshot commit: angular/material2-docs-content@e624c71 We fix this by not including the SHA as part of the deployment, but rather including the SHA when building the NPM packages. At that point, we can safely just replace instances of the `0.0.0-PLACEHOLDER` without having to worry about accidental version overriding. To achieve this, we update our release stamping script to have two modes. i.e. snapshot build mode and release mode. Framework does this by checking the Git tag history but that seems less ideal as it makes the release output building reliant on external factors while our stamping is self-contained within the checked out code revision. (cherry picked from commit 33b31b1)
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
An interesting case that came up in v10.0.0 with the docs-content. The
snapshot release package and docs-content output had various
@breaking-changenotes in the source code referring tov10.0.0ascertain changes are planned to be made at that point.
The snapshot deploy scripts pick up the version from the package.json
file and replace it in the output packages with a more concrete version
that includes the SHA. This meant that we accidentally also overwrote
versions as in the
@breaking-changenotes (ultimately making itdifficult for us to use the latest docs-content for the v10 release as
it was incorrect).
Example snapshot commit: angular/material2-docs-content@e624c71
We fix this by not including the SHA as part of the deployment, but
rather including the SHA when building the NPM packages. At that point,
we can safely just replace instances of the
0.0.0-PLACEHOLDERwithouthaving to worry about accidental version overriding.
To achieve this, we update our release stamping script to have two
modes. i.e. snapshot build mode and release mode. Framework does this
by checking the Git tag history but that seems less ideal as it makes
the release output building reliant on external factors while our
stamping is self-contained within the checked out code revision.