Rename GitHub branch early releases to “previews” #4000
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
colinrotherham
added
the
documentation
colinrotherham
force-pushed
the
publish-preview-branch
branch
from
6494cad to
e549eb7
Compare
colinrotherham
force-pushed
the
publish-preview-branch
branch
from
e549eb7 to
2102013
Compare
package.json
Outdated
| @@ -19,7 +19,7 @@ | |||
| "start": "npm run dev", | |||
| "build-release": "./bin/build-release.sh", | |||
| "publish-release": "./bin/publish-release.sh", | |||
| "pre-release": "./bin/pre-release.sh", | |||
| "preview": "./bin/preview.sh", | |||
There was a problem hiding this comment.
suggestion I think it'd be worth updating that script name to publish-preview (as preview on its own may lead to thinking it starts some local preview).
There was a problem hiding this comment.
Hmm, wouldn't it be build-preview as it's paired with build-release?
There was a problem hiding this comment.
I'll go with publish-preview since that's the task (publishing to a GitHub branch)
But yeah the script is mostly similar to build-release
We’ll refer to ad-hoc GitHub branch releases as “previews” and only use the term “pre-release” for early releases that are also published to npm
We add the `npm version` flag `--allow-same-version` to allow existing previews to updated with the same version number We can’t use `npm pkg get version` due to output differences between npm v8 and v9, plus a “double output” bug only seen in v9: * npm/cli#5481
colinrotherham
force-pushed
the
publish-preview-branch
branch
from
2102013 to
5a5dacd
Compare
| @@ -50,7 +50,8 @@ | |||
| "build:package": "gulp build:package --color", | |||
| "build:release": "gulp build:release --color", | |||
| "build:stats": "npm run stats --workspace govuk-frontend-stats", | |||
| "dev": "gulp dev --color" | |||
| "dev": "gulp dev --color", | |||
| "version": "echo $npm_package_version" | |||
There was a problem hiding this comment.
Nice one! That's clever 😍
romaricpascal
approved these changes
Jul 24, 2023
colinrotherham
added a commit
that referenced
this pull request
Jul 27, 2023
Missed from code review feedback: * #4000 (comment)
paulrobertlloyd
pushed a commit
to x-govuk/govuk-frontend
that referenced
this pull request
Jul 27, 2023
Rename GitHub branch early releases to “previews”
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.
This PR renames our publishing-a-pre-release.md process:
To the term "preview" rather than "pre-release":
We've decided to refer to ad-hoc GitHub branch releases as “previews” since they're not published to npm
Package version for previews
All preview builds now run
npm versionto suffix the branch name in the package.json"version"We can now identify preview versions of GOV.UK Frontend when deployed as part of: