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.

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

document generic releaser #1174

Closed
chingor13 opened this issue Dec 23, 2021 · 0 comments · Fixed by #1157
Closed

document generic releaser #1174

chingor13 opened this issue Dec 23, 2021 · 0 comments · Fixed by #1157
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@chingor13
Copy link
Contributor

Add docs in customizing.md for how to update long-tail files.

@chingor13 chingor13 added the type: docs Improvement to the documentation for an API. label Dec 23, 2021
@chingor13 chingor13 self-assigned this Dec 23, 2021
chingor13 added a commit that referenced this issue Dec 29, 2021
This introduces a new `Generic` updater class that scans the file line by line for annotations.

You can annotate a line (inline) via:
* `x-release-please-version`
* `x-release-please-major`
* `x-release-please-minor`
* `x-release-please-patch`

For these annotations, we will try to replace the value on that line only.

You can annotate a block by starting with a line containing:
* `x-release-please-start-version`
* `x-release-please-start-major`
* `x-release-please-start-minor`
* `x-release-please-start-patch`

and close the block with a line containing `x-release-please-end`. Within the block, we will attempt to replace version values.

Additionally, all basic strategies now support the `extra-files` option which will apply this generic updater class.

Fixes #435
Fixes #305
Fixes #1139
Fixes #1174
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant