FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs(maintaining): add process for release managers by jsjoeio · Pull Request #3360 · coder/code-server · GitHub

/ code-server Public

docs(maintaining): add process for release managers - #3360

Merged
jsjoeio merged 6 commits into
mainfrom
jsjoeio/document-release-manager
May 14, 2021
ConversationCommits (6)ChecksFiles changed
Merged

docs(maintaining): add process for release managers#3360
jsjoeio merged 6 commits into
mainfrom
jsjoeio/document-release-manager

Conversation

jsjoeio commented May 11, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor

Proposal

This a proposal to add process around releases with "Release Managers".

Summary: rotate which maintainer cuts a new release.

How it works now:

  1. random maintainer cuts release
  2. random maintainer creates new version milestone
  3. random maintainer closes previous version milestone

How it will work with proposed approach:

  1. introduces "release manager" role to own release
  2. release manager owns cutting release, creating new version milestone and creating an issue to track next release

Pros

  • reinforces our philosophy -> each PR should have an issue attached (now releases will have issues)
  • explicitly states who owns current release
  • gives each maintainer an opportunity to own a release

Cons

  • adds a couple extra steps to release process
  • requires all maintainers to participate in release process (which may discourage contributions for those who don't care to partake)
  • some extra manual steps (creating a release issue)

Alternatives

  • stick with current process ("if it's not broken, don't fix it")
  • automate creating the release issue
    • add job to publish workflow to automatically create issue using gh

Changes

  • add issue template for release
  • simplify steps in release_template.md
  • remove old steps in ci/README.md
  • update release-prep.sh to not modify CHANGELOG.md
  • document "Release Manager Rotation"

Checklist

  • update CHANGELOG

codecov Bot commented May 11, 2021 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Merging #3360 (56232fa) into main (509d91d) will decrease coverage by 0.26%.
The diff coverage is n/a.

❗ Current head 56232fa differs from pull request most recent head 2438fb3. Consider uploading reports for the commit 2438fb3 to get more accurate results

@@            Coverage Diff             @@
##             main    #3360      +/-   ##
==========================================
- Coverage   59.21%   58.95%   -0.27%     
==========================================
  Files          35       35              
  Lines        1709     1703       -6     
  Branches      379      374       -5     
==========================================
- Hits         1012     1004       -8     
- Misses        559      561       +2     
  Partials      138      138
Impacted Files Coverage Δ
src/node/util.ts 50.00% <0.00%> (-5.24%) ⬇️
src/node/wsRouter.ts 92.00% <0.00%> (ø)
src/node/socket.ts 90.00% <0.00%> (+0.16%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 509d91d...2438fb3. Read the comment docs.

jsjoeio self-assigned this May 11, 2021
jsjoeio added the docs Documentation related label May 11, 2021
jsjoeio added this to the v3.11.0 milestone May 11, 2021
jsjoeio changed the title jsjoeio/document-release-manager docs(maintaining): add process for release managers May 11, 2021
jsjoeio commented May 11, 2021
View reviewed changes
Comment thread .github/ISSUE_TEMPLATE/release.md
Comment thread .github/PULL_REQUEST_TEMPLATE/release_template.md Outdated
Comment thread ci/README.md
Comment thread ci/build/release-prep.sh
Comment thread docs/MAINTAINING.md Outdated
jsjoeio marked this pull request as ready for review May 11, 2021 23:09
jsjoeio requested a review from a team as a code owner May 11, 2021 23:09
jsjoeio requested review from code-asher and oxy May 11, 2021 23:10

jawnsy commented May 11, 2021 •
edited
Loading

Copy link
Copy Markdown

Added @deansheather as a reviewer (optional), in case he has pearls of wisdom to share from his experience as the release manager for Coder 😄

Also added @nathanpotter and @ketang in case they're interested. The final decision on this proposal belongs to the code-server team though.

jawnsy reviewed May 11, 2021
View reviewed changes
Comment thread .github/PULL_REQUEST_TEMPLATE/release_template.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread docs/MAINTAINING.md Outdated
deansheather reviewed May 11, 2021
View reviewed changes
Comment thread CHANGELOG.md Outdated
Comment thread docs/MAINTAINING.md Outdated

## Release Manager Rotation

With each release, we rotate the role of "release manager" to ensure every maintainer goes thorugh the process. This helps us keep documentation up-to-date and encourages us to continually review and improve the flow with each set of eyes.

deansheather May 11, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

You should document the rotation with names

jsjoeio May 11, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

My thinking was having an issue with the release version assigned to the release manager was sufficient. Do you think that's not enough?

jsjoeio May 11, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

And since the release issue is created by the previous release manager and assigned to the next release manager, we have both pieces of data:

  • previous release manager (creator of issue)
  • next release manager (assignee of issue)

oxy reviewed May 12, 2021
View reviewed changes
Comment thread .github/PULL_REQUEST_TEMPLATE/release_template.md Outdated
oxy reviewed May 12, 2021
View reviewed changes
Comment thread ci/README.md Outdated
oxy reviewed May 12, 2021
View reviewed changes
Comment thread docs/MAINTAINING.md Outdated
oxy suggested changes May 12, 2021
View reviewed changes

oxy left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

We can remove the note about double-checking the branch of the tagged commit (since moving from hub to gh made it no longer mangle the tag), and there's a heading depth nit, but otherwise looking good!

jsjoeio force-pushed the jsjoeio/document-release-manager branch 2 times, most recently from 6e293f2 to 6f08804 Compare May 12, 2021 21:32
jsjoeio requested a review from oxy May 12, 2021 21:35

jsjoeio commented May 12, 2021

Copy link
Copy Markdown
Contributor Author

Addressed changes. Ready for a second pass @oxy @code-asher 👀

jsjoeio force-pushed the jsjoeio/document-release-manager branch 2 times, most recently from 56232fa to 01852ae Compare May 13, 2021 22:06
jsjoeio added the chore Related to maintenance or clean up label May 14, 2021
oxy approved these changes May 14, 2021
View reviewed changes

oxy left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks good!

jsjoeio force-pushed the jsjoeio/document-release-manager branch from 01852ae to 27a485c Compare May 14, 2021 17:44
jsjoeio enabled auto-merge May 14, 2021 17:44
jsjoeio removed request for ketang and nathanpotter May 14, 2021 23:08
jsjoeio force-pushed the jsjoeio/document-release-manager branch from 27a485c to 2438fb3 Compare May 14, 2021 23:09
jsjoeio merged commit a3663f5 into main May 14, 2021
jsjoeio deleted the jsjoeio/document-release-manager branch May 14, 2021 23:13
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

deansheather deansheather left review comments
code-asher Awaiting requested review from code-asher
+2 more reviewers
jawnsy jawnsy left review comments
oxy oxy approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

jsjoeio

Labels

chore Related to maintenance or clean up docs Documentation related

Projects

None yet

Milestone

v3.10.1

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL