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

release-process: explain how and when to merge master into release-next #1192

Merged
merged 3 commits into from
Apr 13, 2023

Conversation

maelvls
Copy link
Member

@maelvls maelvls commented Feb 27, 2023

These changes were extracted from #1081 (comment).

Signed-off-by: Maël Valais <mael@vls.dev>
@jetstack-bot jetstack-bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Feb 27, 2023
Comment on lines 592 to 594
When creating a documentation PR for an unreleased feature, you will need to
fast-forward the `release-next` branch to `master` before asking for a review of
the PR:
Copy link
Member Author

@maelvls maelvls Feb 27, 2023

Choose a reason for hiding this comment

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

Copied from #1081 (comment):

I do not agree with this.
It may be desirable to bring release-next up to date before submitting your release-next PR,
but usually only if the new feature you are documenting might conflict with some changes which have meanwhile been merged into the live documentation.

In any case, release-next doesn't have to be "fast-forwarded"...just merged....unless there's a way to create a PR which really does fast forward the commits from one branch to another. Is that possible?

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree. I think I misunderstood the implications of not having release-next up-to-date. Even in my case, I didn't have to update release-next to match master.

  • I will rephrase to make it an optional step only needed if the changes you intend to make to the documentation relies on changes that were made recently to master and aren't in release-next.
  • I will use the word "merge master into release-next" instead of "fast-forward release-next to master". I agree with you, it can't be fast-forwarding and merge commits are needed.

Copy link
Member Author

Choose a reason for hiding this comment

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

I have addressed your comments. Please take another look when you have time.

@netlify
Copy link

netlify bot commented Feb 27, 2023

Deploy Preview for cert-manager-website ready!

Name Link
🔨 Latest commit 1568382
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager-website/deploys/6437b8725e35eb0008195734
😎 Deploy Preview https://deploy-preview-1192--cert-manager-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Signed-off-by: Maël Valais <mael@vls.dev>
@maelvls maelvls changed the title release-process: explain how I fast-forwarded release-next release-process: explain how and when to merge release-next into master Feb 27, 2023
@maelvls maelvls changed the title release-process: explain how and when to merge release-next into master release-process: explain how and when to merge master into release-next Feb 27, 2023
@maelvls
Copy link
Member Author

maelvls commented Mar 10, 2023

@wallrj I think this is ready to be merged.

Signed-off-by: Maël Valais <mael@vls.dev>
@maelvls
Copy link
Member Author

maelvls commented Apr 13, 2023

@wallrj I have removed most of what I had written since I realized that it was already explained in the README. The only thing I kept (and moved to the README) is how to merge master into release-next, and why that may be needed.

Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

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

Thanks @maelvls

/lgtm

Comment on lines +123 to +124
It is necessary because some the merge commits have been written by the bot
and do not have a DCO signoff.
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if it's possible to configure the bot to use --signoff when merging?

Copy link
Member Author

@maelvls maelvls Apr 13, 2023

Choose a reason for hiding this comment

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

@inteon investigated this idea (message):

From what I found it is not possible to add DCO signoff in the commit message. However, I found that the DCO check should actually check if the committer is a bot and not complain in that case, this is not well-documented and needs further investigation. For now, I found that just merging in case all other checks are OK works fine.

Copy link
Member

Choose a reason for hiding this comment

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

That was specific for that generic autobumper tool.
I don't know what tool is used here.

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Apr 13, 2023
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: maelvls, wallrj

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jetstack-bot jetstack-bot merged commit 6a5d27d into cert-manager:master Apr 13, 2023
@maelvls maelvls deleted the release-process-website branch April 13, 2023 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants