Skip to content

Commit

Permalink
add documentation for PR labels for version manager
Browse files Browse the repository at this point in the history
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
KPostOffice committed Jun 21, 2022
1 parent d5b6387 commit f9ab93b
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/managers/version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------
Expand All @@ -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>`_.
Expand All @@ -122,3 +146,6 @@ Manager Author
--------------

Fridolin Pokorny <[email protected]>


..

0 comments on commit f9ab93b

Please sign in to comment.