Skip to content

Commit bc5165d

Browse files
RRosiodanyeaw
andauthored
Update releaser docs (#341)
* update releaser docs * correct mention of next keyword behavior and mention workflow steps to run * update link for releaser docs * Update RELEASE.md Co-authored-by: Dan Yeaw <[email protected]> --------- Co-authored-by: Dan Yeaw <[email protected]>
1 parent b5b6ff9 commit bc5165d

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

RELEASE.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,27 @@
22

33
## Using `jupyter_releaser`
44

5-
The recommended way to make a release is to use [`jupyter_releaser`](https://github.com/jupyter-server/jupyter_releaser#checklist-for-adoption).
5+
The recommended way to make a release is to use [`jupyter_releaser`](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html).
66

7-
Note that we must use manual versions since Jupyter Releaser does not
8-
yet support "next" or "patch" when dev versions are used.
7+
### Versioning
8+
9+
NbClassic follows the following versioning flow: development → pre-release
10+
(optional) → final release. After each release, the version should
11+
be updated to a development version.
12+
13+
To begin a release, from the `Actions` page in GitHub, select the pinned `Step 1: Prep Release` workflow then click on `Run workflow`. The `Use workflow from` option indicates the branch where the workflow file is located, while you can specify any target brach to release from in the corresponding input option. You can use the `New Version Specifier` input to specify the release version, and use the `post_version_spec` to define the development version that the target branch should move to after the release (e.g., 1.2.0.dev0 or 1.1.1.dev0 as needed). When setting a
14+
`post_version_spec`, the full version must be specified. For example,
15+
1.1.1.dev0 or 1.1.1rc0 are acceptable. The term `next` as is defaulted to in the `New Version Specifier` option, will result in a patch version update.
16+
17+
Once the `Step 1: Prep release` workflow completes successfully and ouptus are reviewed, you can run `Step 2: Publish Release` specifying the target branch and optionally the URL of the draft PR generated in the previous prep-release step.
18+
19+
### Changelog
20+
21+
The changelog is updated for both pre-releases and final releases.
22+
Final releases aggregate all the pull requests since the previous
23+
final release. As a result, some PRs may appear multiple times,
24+
likely twice, which is consistent with changelog practices in
25+
other Jupyter projects.
926

1027
## Manual Release
1128

0 commit comments

Comments
 (0)