Skip to content
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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Refine release documentation #378

Merged
merged 1 commit into from Feb 15, 2022
Merged

docs: Refine release documentation #378

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/RELEASE.md
View file
Open in desktop
Expand Up @@ -30,7 +30,7 @@ Currently, the release process is not fully automated, so here is how we do it.

> We are very open for PRs that show how we can automate parts of this process or go for a fully automated process that is able to cover most of this process.
We are open to discuss things that are redundant in PRs.
> I can imagine that we could automatically create pre-releases when anything relevant lands on master. Those pre-release versions won't appear in the changelog, but the github release can (automatically) have all the information.

### 0. Prerequisites for a release

Expand Down Expand Up @@ -65,7 +65,8 @@ We are open to discuss things that are redundant in PRs.
- `npm run release -- $bump` and follow the instructions
- Copy the content of the changelog to the release draft
- Change the first headline to be just a link with the text `Commits`
- `npm run pack` and upload the new file as a binary
- Run `npm pack @xmldom/xmldom` to **download** the published binary
and **upload** the file to the release
- If it's a minor bump: Check the box for creating a release discussion
- If it's a patch bump: update the related release discussion of the minor bump
by adding the changelog to the bottom and changing the discussion title to have an `x` in the patch part of the version.
Expand Down