New default branch name

Tim Schaub
2020-06-20 13:28:32 -06:00
parent 519f066934
commit 52faefe3a6
+5 -5
@@ -2,19 +2,19 @@
The release process involves a couple changes to the repository: updating the version number in package.json and adding a changelog. In order to make these release-related changes, create a branch in your repository clone. Note that all the examples below use 3.1.0 as the release version (and 3.0.0 as the previous release). You'll want to use the appropriate version numbers for the release you're working toward.
git checkout -b release-v3.1.0 openlayers/master
git checkout -b release-v3.1.0 openlayers/main
### Create a changelog
Create a changelog for all merges to master since the previous release. You'll want to create a log for all changes since the previous release and name the resulting file like the target release.
Create a changelog for all merges to `main` since the previous release. You'll want to create a log for all changes since the previous release and name the resulting file like the target release.
./tasks/changelog.sh v3.0.0.. >> changelog/v3.1.0.md
Edit the resulting changelog file with any summary notes or special upgrade considerations.
You can extract the upgrade considerations from the [`changelog/upgrade-notes.md`](https://github.com/openlayers/openlayers/blob/master/changelog/upgrade-notes.md) file, by looking at any upgrade notes since the previous release.
You can extract the upgrade considerations from the [`changelog/upgrade-notes.md`](https://github.com/openlayers/openlayers/blob/main/changelog/upgrade-notes.md) file, by looking at any upgrade notes since the previous release.
If the [`changelog/upgrade-notes.md`](https://github.com/openlayers/openlayers/blob/master/changelog/upgrade-notes.md)
If the [`changelog/upgrade-notes.md`](https://github.com/openlayers/openlayers/blob/main/changelog/upgrade-notes.md)
file does not already have a header for the current release, create a header with the version number (e.g. `### v3.1.0`).
Commit your changes:
@@ -91,7 +91,7 @@ Push the pending changes to the release branch
git push openlayers release-v3.1.0
Give the pull request for the release branch a final review, and merge it into master.
Give the pull request for the release branch a final review, and merge it into `main`.
### Update website