Do not require changelog entry for docs #278
Merged
Conversation
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
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
ptgott
force-pushed
the
paul.gottschling/2024-07-docs-no-changelog
branch
2 times, most recently
from
ca59a6c to
3e7173c
Compare
ptgott
changed the title
no-changelog
ptgott
force-pushed
the
paul.gottschling/2024-07-docs-no-changelog
branch
from
3e7173c to
7f2d783
Compare
ptgott
force-pushed
the
paul.gottschling/2024-07-docs-no-changelog
branch
from
7f2d783 to
9e22a95
Compare
zmb3
approved these changes
Jan 31, 2025
fheinecke
requested changes
Feb 3, 2025
There was a problem hiding this comment.
This needs changes to maintain compatibility with release tooling, as discussed on slack here: https://gravitational.slack.com/archives/C0351AUPJ8K/p1738617752346529
Docs-only changes do not require a changelog entry, as we reserve the changelog for changes to the product. Edit the changelog workflow to ignore docs-only changes.
ptgott
force-pushed
the
paul.gottschling/2024-07-docs-no-changelog
branch
from
9e22a95 to
5f783ba
Compare
fheinecke
approved these changes
Feb 6, 2025
Automatically add the `no-changelog` label for docs-only changes. This reduces friction for docs authors, since docs-only changes usually don't require changelog entries. Do this instead of automatically skipping the changelog check for docs-only changes, since our release workflow often requires us to add or check the `no-changelog` label manually.
ptgott
force-pushed
the
paul.gottschling/2024-07-docs-no-changelog
branch
from
5f783ba to
9078af9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs-only changes do not require a changelog entry, as we reserve the
changelog for changes to the product. Edit the changelog workflow to
ignore docs-only changes.