Skip to content

Commit 88bea11

Browse files
authored
Merge pull request #297 from ckeditor/pomek-patch-1
Internal: Update README.md.
2 parents 324b58e + 6ed0db8 commit 88bea11

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,20 @@ npm run build
6464

6565
### Prerequisites
6666

67-
The release process is automated via CircleCI and it can release both channels: stable (`X.Y.Z`) and pre-releases (`X.Y.Z-alpha.X`, etc.).
67+
CircleCI automates the release process and can release both channels: stable (`X.Y.Z`) and pre-releases (`X.Y.Z-alpha.X`, etc.).
6868

6969
Before you start, you need to prepare the changelog entries.
7070

7171
1. Make sure the `#master` branch is up-to-date: `git fetch && git checkout master && git pull`.
72-
1. Prepare a release branch: `git checkout -b release-[YYYY-MM-DD]` where `YYYY-MM-DD` is the current day.
73-
1. Generate the changelog entries: `yarn run changelog --branch release-[YYYY-MM-DD] [--from [GIT_TAG]]`.
74-
* By default, the changelog generator uses the latest published tag as a starting point for collecting commits to process.
75-
The `--from` modifier option allows overriding the default behavior. It is required when preparing the changelog entries for the next stable release while the previous one was marked as a prerelease, e.g., `@alpha`.
76-
**Example**: Let's assume that the `v40.5.0-alpha.0` tag is our latest and that we want to release it on a stable channel. The `--from` modifier should be equal to `--from v40.4.0`.
77-
* This task checks what changed in each package and bumps the version accordingly. It won't create a new changelog entry if nothing changes at all. If changes were irrelevant (e.g., only dependencies), it would make an "_internal changes_" entry.
78-
* Scan the logs printed by the tool to search for errors (incorrect changelog entries). Incorrect entries (e.g., ones without the type) should be addressed. You may need to create entries for them manually. This is done directly in CHANGELOG.md (in the root directory). Make sure to verify the proposed version after you modify the changelog.
72+
1. Prepare a release branch: `git checkout -b release-[YYYYMMDD]` where `YYYYMMDD` is the current day.
73+
1. Generate the changelog entries: `yarn run changelog --branch release-[YYYYMMDD] [--from [GIT_TAG]]`.
74+
* By default, the changelog generator uses the latest published tag as a starting point for collecting commits to process.
75+
76+
The `--from` modifier option allows overriding the default behavior. It is required when preparing the changelog entries for the next stable release while the previous one was marked as a prerelease, e.g., `@alpha`.
77+
78+
**Example**: Let's assume that the `v40.5.0-alpha.0` tag is our latest and that we want to release it on a stable channel. The `--from` modifier should be equal to `--from v40.4.0`.
79+
* This task checks what changed in each package and bumps the version accordingly. It won't create a new changelog entry if nothing changes at all. If changes were irrelevant (e.g., only dependencies), it would make an "_internal changes_" entry.
80+
* Scan the logs printed by the tool to search for errors (incorrect changelog entries). Incorrect entries (e.g., ones without the type) should be addressed. You may need to create entries for them manually. This is done directly in CHANGELOG.md (in the root directory). Make sure to verify the proposed version after you modify the changelog.
7981
1. Commit all changes and prepare a new pull request targeting the `#master` branch.
8082
1. Ping the `@ckeditor/ckeditor-5-devops` team to review the pull request and trigger the release process.
8183

0 commit comments

Comments
 (0)