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

Jump to bottom

docs: clarify automation in release workflow #13851

Merged
merged 6 commits into from
Dec 11, 2024
Merged

docs: clarify automation in release workflow #13851

merged 6 commits into from
Dec 11, 2024

Conversation

inge4pres
Copy link
Contributor

Motivation/summary

During the 8.15 release cycle we noticed some differences between what documented as needed and the available tooling for release.
This Pr is an attempt to clarify what's documented.

@inge4pres inge4pres added the docs label Aug 8, 2024
@inge4pres inge4pres requested a review from a team as a code owner August 8, 2024 17:23
@mergify Mergify
Copy link
Contributor

mergify bot commented Aug 8, 2024

This pull request does not have a backport label. Could you fix it @inge4pres? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-7.17 is the label to automatically backport to the 7.17 branch.
  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit.

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Aug 8, 2024
carsonip
carsonip reviewed Aug 8, 2024
View reviewed changes
dev_docs/RELEASES.md Outdated Show resolved Hide resolved
dev_docs/RELEASES.md Outdated
@@ -72,7 +72,9 @@ For patch releases, only the version on the existing major and minor version bra

* A new [tag](https://github.com/elastic/apm-server/releases) will automatically be created on GitHub.

* Bump the version in anticipation of the next release, e.g. [after 8.13.3 release](https://github.com/elastic/apm-server/pull/13066) bump to 8.13.4. **Prepare this PR ahead of time** but only merge it once pinged by the Release Manager on release date.
* Merge the PRs created by the GitHub workflow ran as part of the steps in the ["Day after feature freeze"](#day-after-feature-freeze) section.
Copy link
Member

Choose a reason for hiding this comment

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

This only applies to patch release, not minor release, right?

Copy link
Member

Choose a reason for hiding this comment

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

I agree and this needs to be clarified as there are a lot of PRs involved in this process and as we discovered recently other PRs (docs + version bumps) must not be merged before release date.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do we need to do to clarify? Reach out to the robots?

This only applies to patch release, not minor release, right?

Good point, thanks for the callout. Should we make a distinction like we do above for minor/patch release?
E.g. say: "for minor releases, merge this and that; for patch releases, merge this other and that other PR".

Copy link
Member

Choose a reason for hiding this comment

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

I think the old bullet point was correct, no? Basically on the release day the next patch version bump has to happen, everything else is supposed to already be done by the day after feature freeze or the day before release.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It depends how we structure the flow, I think.
The old doc assumed the version bump PR is created on FF, and merged on release day.
I don't see why a time distance between the 2 events should exist, and I see more risk in creating and merging a PR for version bump before we are requested to do so (as we would produce a DRA version that is too early).
That's why I added the "IMPORTANT" section below, but I also agree that the previous phrasing was more correct.
I'll amend that

@carsonip carsonip requested a review from endorama August 9, 2024 08:08
@v1v v1v added the backport-8.x Automated backport to the 8.x branch with mergify label Sep 10, 2024
@mergify mergify bot removed the backport-skip Skip notification from the automated backport with mergify label Sep 10, 2024
@carsonip carsonip requested a review from 1pkg December 3, 2024 16:29
@carsonip
Copy link
Member

carsonip commented Dec 3, 2024

@inge4pres Do the changes still apply? Do you want to hand this PR over to @1pkg ?

1pkg
1pkg reviewed Dec 3, 2024
View reviewed changes
dev_docs/RELEASES.md Outdated
This workflow will: create the release branch; update version across codebase; commit and create PR targeting the release branch.
Release notes for patch releases **must be manually added** (PR should target `main` branch and backported to the release branch):
This workflow will: create the `update-<VERSION>` branch, update version constants across the codebase and create a PR targeting the release branch.
Release notes for patch releases **must be manually added** (PR should target `main` branch and should be backported to the release branch):
Copy link
Member

Choose a reason for hiding this comment

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

I would add here must be manually added a day before release

Copy link
Member

Choose a reason for hiding this comment

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

Teams do it on either D-1 or release day. I think it is fine to specify it as D-1 here for clarity.

1pkg
1pkg previously approved these changes Dec 3, 2024
View reviewed changes
@inge4pres inge4pres force-pushed the dev-docs/release-clarify-workflow branch from dacb6d9 to 2e011b1 Compare December 9, 2024 18:15
@inge4pres
Copy link
Contributor Author

Amended the phrasing as suggested, trying to see how the preview renders the important block

@inge4pres inge4pres requested review from carsonip and 1pkg December 9, 2024 18:15
@inge4pres
Copy link
Contributor Author

how the preview renders the important block

works with latest commit

1pkg
1pkg previously approved these changes Dec 10, 2024
View reviewed changes
@inge4pres inge4pres removed the request for review from endorama December 10, 2024 14:03
carsonip
carsonip previously approved these changes Dec 10, 2024
View reviewed changes
@inge4pres inge4pres enabled auto-merge (squash) December 11, 2024 17:26
inge4pres and others added 5 commits December 11, 2024 18:35
@inge4pres
docs: clarify automation in release workflow
737698d 
Signed-off-by: inge4pres <[email protected]>
@inge4pres
fix formatting
b9404dc 
Signed-off-by: inge4pres <[email protected]>
@inge4pres @carsonip
spelling fix
4d12a68 
Co-authored-by: Carson Ip <[email protected]>
Signed-off-by: inge4pres <[email protected]>
@inge4pres
better phrasing
c193984 
Signed-off-by: inge4pres <[email protected]>
@inge4pres
fix important callout
e3911a2 
Signed-off-by: inge4pres <[email protected]>
@inge4pres inge4pres dismissed stale reviews from carsonip and 1pkg via e3911a2 December 11, 2024 17:36
@inge4pres inge4pres force-pushed the dev-docs/release-clarify-workflow branch from 96d0743 to e3911a2 Compare December 11, 2024 17:36
@inge4pres inge4pres requested a review from 1pkg December 11, 2024 17:37
@inge4pres inge4pres merged commit a813495 into elastic:main Dec 11, 2024
7 checks passed
mergify bot pushed a commit that referenced this pull request Dec 11, 2024
@inge4pres @mergify
docs: clarify automation in release workflow (#13851)
95b8c27 
Signed-off-by: inge4pres <[email protected]>
Co-authored-by: Carson Ip <[email protected]>
Co-authored-by: Kostiantyn Masliuk <[email protected]>
(cherry picked from commit a813495)
@mergify mergify bot mentioned this pull request Dec 11, 2024
Merged
mergify bot added a commit that referenced this pull request Dec 11, 2024
@mergify @inge4pres
docs: clarify automation in release workflow (#13851) (#14907)
6681cdb 
Signed-off-by: inge4pres <[email protected]>
Co-authored-by: Carson Ip <[email protected]>
Co-authored-by: Kostiantyn Masliuk <[email protected]>
(cherry picked from commit a813495)

Co-authored-by: Francesco Gualazzi <[email protected]>
@inge4pres inge4pres deleted the dev-docs/release-clarify-workflow branch December 11, 2024 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@endorama endorama endorama left review comments

@1pkg 1pkg 1pkg approved these changes

@carsonip carsonip carsonip left review comments

Assignees
No one assigned
Labels
backport-8.x Automated backport to the 8.x branch with mergify docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@inge4pres @carsonip @endorama @1pkg @v1v