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

Use v2 of the publish-technical-documentation-release workflow #10374

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jdbaldry
Copy link
Member

@jdbaldry jdbaldry commented Jan 8, 2025

What this PR does

v2 includes an additional step to check out the HEAD of the release branch before syncing on tag events. This ensures that tags made to older commits on a release branch don't revert documentation.

https://github.com/grafana/writers-toolkit/blob/main/publish-technical-documentation-release/action.yaml#L65-L84

Which issue(s) this PR fixes or relates to

Fixes https://raintank-corp.slack.com/archives/C03Q42RLMRQ/p1736193190664809

Checklist

  • Tests updated.
  • Documentation added.
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX].
  • about-versioning.md updated with experimental features.

v2 includes an additional step to check out the HEAD of the release branch before syncing on tag events.
This ensures that tags made to older commits on a release branch don't revert documentation.

https://github.com/grafana/writers-toolkit/blob/main/publish-technical-documentation-release/action.yaml#L65-L84

Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry requested review from a team as code owners January 8, 2025 11:45
@tacole02
Copy link
Contributor

tacole02 commented Jan 8, 2025

Thanks, @jdbaldry !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants