-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add documentation for PR labels for version manager
I added configuration documentation for the ability to trigger version manager directly from a PR using labels. I also added it to the example configuration for the version manager.
- Loading branch information
1 parent
d5b6387
commit f9ab93b
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -74,6 +74,22 @@ Configuration | |
- string | ||
- "CLUSTER_SIMILAR" | ||
- see Glyphs `README`_ for a list of supported formatters | ||
* - pr_releases | ||
- boolean | ||
- true | ||
- automatically create releases from appropriately labeled PRs | ||
* - release_label_config | ||
- Object[str, List[str]] | ||
- | release_label_config: | ||
| calendar: [calendar-release] | ||
| major: [major-release] | ||
| minor: [minor-release] | ||
| patch: [patch-release] | ||
| pre: [pre-release] | ||
| build: [build-release] | ||
| finalize: [finalize-version] | ||
- list of labels in a PR that will trigger a specific type of release. Setting configuration for only a subset | ||
of the release types will leave the rest of the defaults unchanged. | ||
|
||
Example | ||
------- | ||
|
@@ -99,6 +115,14 @@ An example configuration: | |
- sesheta | ||
# Add release information to CHANGELOG.md file automatically. | ||
changelog_file: true | ||
release_label_config: | ||
# calendar: [calendar-release] remains unchanged | ||
major: [major-v] | ||
minor: [minor-v] | ||
patch: [patch-v] | ||
# pre: [pre-release] remains unchanged | ||
# build: [build-release] remains unchanged | ||
finalize: [] | ||
An example of this version manager in action can be found `here | ||
<https://github.com/thoth-station/kebechet/issues/98>`_. | ||
|
@@ -122,3 +146,6 @@ Manager Author | |
-------------- | ||
|
||
Fridolin Pokorny <[email protected]> | ||
|
||
|
||
.. |