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

docs: release template: update based on 1.28 learnings #12356

Merged
merged 12 commits into from
Aug 9, 2024

Conversation

BigLep
Copy link
Member

@BigLep BigLep commented Aug 8, 2024

This takes release issue changes and observations from #12109 with also having an eye towards the upcoming release process changes per #12072 .

The general goals here are:

  1. Have a checkbox step for each step a releae engineer should take.
  2. Reduce duplication in the template itself. Where content should be duplicated, there is a comment for the issue creator to handle the copy/pasting.

Checklist

Before you mark the PR ready for review, please make sure that:

  • Commits have a clear commit message.
  • PR title is in the form of of <PR type>: <area>: <change being made>
    • example: fix: mempool: Introduce a cache for valid signatures
    • PR type: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test
    • area, e.g. api, chain, state, mempool, multisig, networking, paych, proving, sealing, wallet, deps
  • Update CHANGELOG.md or signal that this change does not need it.
    • If the PR affects users (e.g., new feature, bug fix, system requirements change), update the CHANGELOG.md and add details to the UNRELEASED section.
    • If the change does not require a CHANGELOG.md entry, do one of the following:
      • Add [skip changelog] to the PR title
      • Add the label skip/changelog to the PR
  • Tests exist for new functionality or change in behavior
  • CI is green

This takes release issue changes and observations from #12109 with also having an eye towards the upcoming release process changes per #12072 .

The general goals here are:
1. Have a checkbox step for each step a releae engineer should take.
2. Reduce duplication in the template itself.  Where content should be duplicated, there is a comment for the issue creator to handle the copy/pasting.
@BigLep BigLep added the skip/changelog This change does not require CHANGELOG.md update label Aug 8, 2024
@BigLep BigLep self-assigned this Aug 8, 2024
Copy link
Member Author

@BigLep BigLep left a comment

Choose a reason for hiding this comment

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

This is a self-review to adjust some fixes and also to leave comments for reviewers like @rjan90 .

documentation/misc/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
documentation/misc/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
documentation/misc/RELEASE_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
documentation/misc/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
documentation/misc/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
documentation/misc/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
documentation/misc/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
documentation/misc/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
documentation/misc/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
documentation/misc/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
@BigLep BigLep requested a review from rjan90 August 8, 2024 06:47
@BigLep BigLep marked this pull request as ready for review August 8, 2024 06:47
@BigLep
Copy link
Member Author

BigLep commented Aug 8, 2024

@rjan90 : this is a proposed set of changes that I'm thinking would be good to land before copy/pasting in to #12343

@BigLep
Copy link
Member Author

BigLep commented Aug 8, 2024

@rjan90 : in terms of terminology, are we going to say "Lotus Node" or "Lotus Client"? I think my release template update goes with "Lotus Node" (aligning with NodeBuildVersion), but I'm noticing #12072 talks about "Lotus Client" and I also see that in the title in #12157

Addded some commands for helping identify holes in changelog.
@BigLep BigLep merged commit 67b7361 into master Aug 9, 2024
83 checks passed
@BigLep BigLep deleted the docs/update-release-template-based-on-1.28 branch August 9, 2024 20:36
rjan90 added a commit to hanabi1224/lotus that referenced this pull request Aug 12, 2024
…ect#12356)

This takes release issue changes and observations from filecoin-project#12109 with also having an eye towards the upcoming release process changes per filecoin-project#12072 .

The general goals here are:
1. Have a checkbox step for each step a releae engineer should take.
2. Reduce duplication in the template itself.  Where content should be duplicated, there is a comment for the issue creator to handle the copy/pasting.

* Removed experimental syntax testing.

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Addressing feedback about version string update in master

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Clarifying with comments that backport step doesn't really apply to RC1.

* Cleanup Changelog prep steps.
Addded some commands for helping identify holes in changelog.

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
rjan90 added a commit that referenced this pull request Aug 12, 2024
This takes release issue changes and observations from #12109 with also having an eye towards the upcoming release process changes per #12072 .

The general goals here are:
1. Have a checkbox step for each step a releae engineer should take.
2. Reduce duplication in the template itself.  Where content should be duplicated, there is a comment for the issue creator to handle the copy/pasting.

* Removed experimental syntax testing.

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Addressing feedback about version string update in master

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Clarifying with comments that backport step doesn't really apply to RC1.

* Cleanup Changelog prep steps.
Addded some commands for helping identify holes in changelog.

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip/changelog This change does not require CHANGELOG.md update
Projects
Status: ☑️ Done (Archive)
Development

Successfully merging this pull request may close these issues.

2 participants