mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
7c6eae0ee6
* chore: add the reference change to npm version * chore: remove unused require * chore: add conventional-changelog * chore: add git to pre-release config changes * style: formatting * chore: fix commit message * chore: add no-verify to commit of configs * chore: no more shellJs * chore: fixing async * chore: committing restored * refactor: move and rename * chore: remove shelljs devdep and old script * chore: change npm script ref after refactor * chore: upgrade-config code improvements * chore: edit package.json (not package-lock) * chore(changelog): use conventionalcommits preset * chore: add conventional changelog config * chore: use .versionrc directly * chore: update changelog config * chore: update .versionrc.json * chore: use standard-version * chore: change to standard version * styling(changelog): remove a tags + formatting * styling: conventiontal-changelog styling * chore: postformatting of changelog * chore: remove unnecessary dependencies * chore: add upgrade-config to version as backup * docs: update release.md * styling: order scripts alphabetically * docs: requested changes + dry-run explanation * chore: release script to TS * chore: use ts-node to execute the TS scripts * docs: add some documentation comments to script * docs: remove unnecessary newline * docs: fix comment linting * chore: add test/integration and templates configs * chore: correct automated commit message * chore: remove fdir dependency * chore: remove manual-git-changelog dependency * chore: impl requested changes * docs: update script comments * chore: ensure full cov * chore: review comments
38 lines
2.1 KiB
Markdown
38 lines
2.1 KiB
Markdown
# Releasing a new version
|
|
|
|
This is only relevant if you are a developer with push access responsible for doing a new release.
|
|
|
|
Steps to follow:
|
|
|
|
* Merge `main` into `versions/x.0.0`.
|
|
* Verify if there are issues when upgrading an existing installation to the new version.
|
|
* Can the data still be accessed?
|
|
* Does authentication still work?
|
|
* Is there an issue upgrading the recipes at <https://github.com/CommunitySolidServer/recipes>
|
|
* None of the above has to be blocking per se, but should be noted in the release notes if relevant.
|
|
* Verify that the RELEASE_NOTES.md are correct.
|
|
* `npm run release -- -r major` or `npx standard-version -r major`
|
|
* Automatically updates Components.js references to the new version. Committed with `chore(release): Update configs to vx.0.0`.
|
|
* Updates the `package.json`, generate a tag, and generate the new entries in `CHANGELOG.md`. Commited with `chore(release): Release version vx0.0 of the npm package`
|
|
* You can always add `--dry-run` to the above command to preview the commands that will be run and the changes to `CHANGELOG.md`.
|
|
* Manually edit the `CHANGELOG.md`.
|
|
* All entries are added in separate sections of the new release according to their commit prefixes.
|
|
* Re-organize the entries accordingly, referencing previous releases.
|
|
* Most of the entries in Chores and Documentation can be removed.
|
|
* Make sure there are 2 newlines between this and the previous section.
|
|
* `git add CHANGELOG.md && git commit --amend --no-edit --no-verify` to add manual changes to the release commit.
|
|
* `git push --follow-tags`
|
|
* Merge `versions/x.0.0` into `main` and push.
|
|
* Do a GitHub release.
|
|
* `npm publish`
|
|
* Rename the `versions/x.0.0` branch to the next version.
|
|
* Update `.github/workflows/schedule.yml` and `.github/dependabot.yml` to point at the new branch.
|
|
* Potentially upgrade the recipes at <https://github.com/CommunitySolidServer/recipes>
|
|
|
|
Changes when doing a pre-release of a major version:
|
|
|
|
* Version with `npm release -- -r major --pre-release alpha`
|
|
* Do not merge `versions/x.0.0` into `main`.
|
|
* Publish with `npm publish --tag next`.
|
|
* Do not update the branch or anything related.
|