-
Notifications
You must be signed in to change notification settings - Fork 1
docs: add RELEASING.md #29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Releasing | ||
|
|
||
| `dc-polyfill` is published to npm as [`dc-polyfill`](https://www.npmjs.com/package/dc-polyfill). Releases are currently cut manually by a maintainer with publish access to the package on npm. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Push access to `main` on this repository. | ||
| - The [`gh`](https://cli.github.com/) CLI, authenticated against `DataDog/dc-polyfill`. | ||
| - Log in to an npm account with publish access to `dc-polyfill`. Check with `npm whoami`; run `npm login` if needed. If you don't have publish access, ask an existing maintainer. | ||
|
|
||
| ## Cutting a release | ||
|
|
||
| ```sh | ||
| # Make sure main is green and up to date. | ||
| git checkout main | ||
| git pull origin main | ||
|
|
||
| # Bump the version. Pick patch, minor, or major per semver. | ||
| # This updates package.json, creates a commit (e.g. "0.1.11"), | ||
| # and creates a matching v0.1.11 tag locally. | ||
| npm version patch | ||
|
|
||
| # Sanity-check what will be packed before publishing anything public. | ||
| npm publish --dry-run | ||
|
|
||
| # Publish to npm. Do this before pushing the tag so a failed publish | ||
| # doesn't leave a release tag in the repo that points at no npm version. | ||
| npm publish | ||
|
|
||
| # Push the version-bump commit and the tag. | ||
| git push origin main --follow-tags | ||
|
|
||
| # Create the GitHub release with autogenerated notes. | ||
| gh release create "v$(node -p "require('./package.json').version")" --generate-notes | ||
| ``` | ||
|
|
||
| ## Verifying the release | ||
|
|
||
| ```sh | ||
| # Confirm the new version is live on npm. | ||
| npm view dc-polyfill version | ||
|
|
||
| # Confirm the GitHub release exists. | ||
| gh release view "v$(node -p "require('./package.json').version")" | ||
| ``` | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.