Skip to content

Commit

Permalink
Update README.md (RasaHQ#10387)
Browse files Browse the repository at this point in the history
* clarify micro releases don't need to update sdk
* clarify which PR number to add to changelog when issue does not exist
  • Loading branch information
carlad authored Nov 26, 2021
1 parent b5f7670 commit 2c17cd2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ Releasing a new version is quite simple, as the packages are build and distribut

*Release steps*:
1. Make sure all dependencies are up to date (**especially Rasa SDK**)
- For Rasa SDK that means first creating a [new Rasa SDK release](https://github.com/RasaHQ/rasa-sdk#steps-to-release-a-new-version) (make sure the version numbers between the new Rasa and Rasa SDK releases match)
- For Rasa SDK, except in the case of a micro release, that means first creating a [new Rasa SDK release](https://github.com/RasaHQ/rasa-sdk#steps-to-release-a-new-version) (make sure the version numbers between the new Rasa and Rasa SDK releases match)
- Once the tag with the new Rasa SDK release is pushed and the package appears on [pypi](https://pypi.org/project/rasa-sdk/), the dependency in the rasa repository can be resolved (see below).
2. In case of a minor release, create a new branch that corresponds to the new release, e.g.
```bash
Expand Down
6 changes: 3 additions & 3 deletions changelog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Each file should be named like `<ISSUE>.<TYPE>.md`, where

So for example: `123.feature.md`, `456.bugfix.md`.

If your PR fixes an issue, use that number here. If there is no issue,
then after you submit the PR and get the PR number you can add a
changelog using that instead.
If your change fixes an issue, use the issue number here. If there is no issue,
then after you submit the PR with your changes and get the PR number, you can add a
changelog using that PR number instead.

If you are not sure what issue type to use, don't hesitate to ask in your PR.

Expand Down

0 comments on commit 2c17cd2

Please sign in to comment.