Skip to content

Commit efa0f28

Browse files
Add docs for starting making prereleases (#454)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent a504a5b commit efa0f28

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

docs/source/get_started/making_release_from_repo.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,20 @@ already uses Jupyter Releaser using workflows on its own repository.
1717

1818
![Prep Release Workflow Dialog](../images/prep_release_repo.png)
1919

20-
- The "New Version Spec" will usually be the full version (e.g. 0.7.1). Repos using `tbump` can also use the "next" or "patch"
21-
option, which will bump the micro version (or the build version in the case of a prerelease). The "minor" option allows projects using "tbump" to bump
22-
to the next minor version directly. Note: The "next" and "patch" options
23-
are not available when using dev versions, you must use explicit versions
20+
- The "New Version Spec" will usually be the full version (e.g. 0.7.1). Repos using `tbump` can also use:
21+
- "next" or "patch" option, which will bump the micro version (or the build version in the case of a prerelease).
22+
Note: The "next" and "patch" options are not available when using dev versions, you must use explicit versions
2423
instead.
25-
- Use the "since" field to select PRs prior to the latest tag to include in the release
26-
- Type "true" in the "since the last stable git tag" if you would like to include PRs since the last non-prerelease version tagged on the target repository and branch.
27-
- The additional "Post Version Spec" field should be used if your repo uses a dev version (e.g. 0.7.0.dev0)
28-
- The workflow will use the GitHub API to find the relevant pull requests and make an appropriate changelog entry.
29-
- The workflow will create a draft GitHub release to the target
30-
repository and branch, with the draft changelog contents.
31-
32-
![Prep Release Changelog Workflow Next Step](../images/prep_release_next_step.png)
24+
- "minor" option, which will bump to the next minor version directly.
25+
- "release" option, which will start making prereleases (a0, a1...)
26+
- Use the "since" field to select PRs prior to the latest tag to include in the release
27+
- Type "true" in the "since the last stable git tag" if you would like to include PRs since the last non-prerelease version tagged on the target repository and branch.
28+
- The additional "Post Version Spec" field should be used if your repo uses a dev version (e.g. 0.7.0.dev0)
29+
- The workflow will use the GitHub API to find the relevant pull requests and make an appropriate changelog entry.
30+
- The workflow will create a draft GitHub release to the target
31+
repository and branch, with the draft changelog contents.
32+
33+
![Prep Release Changelog Workflow Next Step](../images/prep_release_next_step.png)
3334

3435
## Review Changelog
3536

0 commit comments

Comments
 (0)