Add docs for the releases workflow#2351
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds maintainer-facing documentation for the manual npm publishing workflow and clarifies dist-tag constraints to help prevent incorrect releases.
Changes:
- Added
docs/release.mddescribing the “Publish NPM” workflow, its inputs, dist-tag usage, and example release scenarios. - Updated the
npm-taginput description in the release workflow to clarify that semver values are invalid dist-tags.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/release.md | New release guide explaining workflow usage, dist-tags, safety guard behavior, and example release inputs. |
| .github/workflows/releases.yml | Documentation-only tweak to the npm-tag input description to warn about invalid (semver) dist-tags. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
luketomlinson
approved these changes
Mar 16, 2026
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
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.
Related to: https://github.com/github/actions-persistence/issues/784
This pull request improves the documentation and configuration for the npm release workflow. The main focus is on clarifying how npm dist-tags should be used and providing clear release instructions for maintainers. There are no code changes, only documentation and a minor clarification in the workflow file.