Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add documentation for PR labels for version manager #1073

Merged
merged 1 commit into from
Jun 21, 2022
Merged

add documentation for PR labels for version manager #1073

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/managers/version.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,23 @@ 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
harshad16 marked this conversation as resolved.
Show resolved Hide resolved
- 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 +116,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 +147,6 @@ Manager Author
--------------

Fridolin Pokorny <[email protected]>


..