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

Add automation for version bumps (patch releases only) #2906

Merged
merged 3 commits into from
Jan 26, 2024

Conversation

bmorelli25
Copy link
Member

Summary

This PR adds a workflow to automate the creation of a version bump PR for Elastic Stack patch releases.

Why

Patch releases make up approximately 79% of Elastic Stack releases and occur roughly once every two weeks. For the documentation release manager, the list of tasks includes, but is definitely not limited to:

  • open an issue in elastic/dev
  • open a PR in elastic/docs
  • open a PR in elastic/docs.elastic.co
  • full rebuild (going away with BuildKite builds)

I'd like to automate each of these steps. This PR is the first automation attempt.

How does it work

To open a version bump, a user simply needs to input the version that is being released and click "run". Within 30 seconds a PR will open.
Screenshot 2024-01-24 at 3 56 38 PM

Notes

This was tested in a private repo and works. We should double-check after this is merged to ensure that Elastic org perms don't break anything.

Next steps

  • Add similar automation to elastic/docs.elastic.co https://github.com/elastic/docs.elastic.co/pull/200
  • Automate issue creation (in progress)
  • Single automation to trigger all three (PR, PR, issue) when managing a release (later)
  • Add automation for minor releases (later)

@bmorelli25 bmorelli25 requested a review from a team as a code owner January 25, 2024 16:59
@bmorelli25 bmorelli25 self-assigned this Jan 25, 2024
Copy link

A documentation preview will be available soon.

Help us out by validating the Buildkite preview and reporting issues here.
Please also be sure to double check all images to ensure they are correct in the preview.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@bmorelli25 bmorelli25 requested a review from lcawl January 25, 2024 16:59
Copy link
Contributor

@glitteringkatie glitteringkatie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@bmorelli25 bmorelli25 enabled auto-merge (squash) January 26, 2024 18:59
@bmorelli25 bmorelli25 merged commit ed8b3b8 into master Jan 26, 2024
4 of 5 checks passed
@bmorelli25 bmorelli25 deleted the patch-release-version-bump branch January 26, 2024 19:35
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.

2 participants