From 83eade6897a7d16e481557b18744aba7a8e3af0e Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 23 Sep 2021 12:02:35 -0700 Subject: [PATCH 1/5] docs: remove oxy from current maintainers --- docs/MAINTAINING.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index 5a6634156..a23e4ac72 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -2,18 +2,19 @@ # Maintaining -- [Workflow](#workflow) - - [Milestones](#milestones) - - [Triage](#triage) - - [Project boards](#project-boards) -- [Versioning](#versioning) -- [Pull requests](#pull-requests) - - [Merge strategies](#merge-strategies) - - [Changelog](#changelog) -- [Releases](#releases) - - [Publishing a release](#publishing-a-release) -- [Documentation](#documentation) - - [Troubleshooting](#troubleshooting) +- [Maintaining](#maintaining) + - [Workflow](#workflow) + - [Milestones](#milestones) + - [Triage](#triage) + - [Project boards](#project-boards) + - [Versioning](#versioning) + - [Pull requests](#pull-requests) + - [Merge strategies](#merge-strategies) + - [Changelog](#changelog) + - [Releases](#releases) + - [Publishing a release](#publishing-a-release) + - [Documentation](#documentation) + - [Troubleshooting](#troubleshooting) @@ -21,7 +22,6 @@ Current maintainers: - @code-asher - @TeffenEllis -- @oxy - @jsjoeio This document is meant to serve current and future maintainers of code-server, From bf10341e3ffe6d3fc29b7ae3bc41930107001524 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 23 Sep 2021 12:04:14 -0700 Subject: [PATCH 2/5] docs(maintaining): refactor and add Team section --- docs/MAINTAINING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index a23e4ac72..471132f74 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -3,6 +3,7 @@ # Maintaining - [Maintaining](#maintaining) + - [Team](#team) - [Workflow](#workflow) - [Milestones](#milestones) - [Triage](#triage) @@ -18,14 +19,18 @@ +This document is meant to serve current and future maintainers of code-server, +as well as share our workflow for maintaining the project. + +## Team + Current maintainers: - @code-asher - @TeffenEllis - @jsjoeio -This document is meant to serve current and future maintainers of code-server, -as well as share our workflow for maintaining the project. +Occassionally, other Coder employees may step in time to time to assist with code-server. ## Workflow From 05d66c1358c534deb4f55326c687091614d09b37 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 23 Sep 2021 12:12:34 -0700 Subject: [PATCH 3/5] docs(maintaining): add onboarding and offboarding --- docs/MAINTAINING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index 471132f74..ccdfc33d7 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -1,9 +1,12 @@ + # Maintaining - [Maintaining](#maintaining) - [Team](#team) + - [Onboarding](#onboarding) + - [Offboarding](#offboarding) - [Workflow](#workflow) - [Milestones](#milestones) - [Triage](#triage) @@ -32,6 +35,22 @@ Current maintainers: Occassionally, other Coder employees may step in time to time to assist with code-server. +### Onboarding + +To onboard a new maintainer to the project, please make sure to do the following: + +- [ ] Add to [cdr/code-server-reviewers](https://github.com/orgs/cdr/teams/code-server-reviewers) +- [ ] Add as Admin under [Repository Settings > Access](https://github.com/cdr/code-server/settings/access) +- [ ] Add to [npm Coder org](https://www.npmjs.com/org/coder) +- [ ] Add as [AUR maintainer](https://aur.archlinux.org/packages/code-server/) (talk to Colin) +- [ ] Introduce to community via Discussion (see [example](https://github.com/cdr/code-server/discussions/3955)) + +### Offboarding + +Very similar to Onboarding but Remove maintainer from all teams and revoke access. Please also do the following: + +- [ ] Write fairwell post via Discussion (see [example](https://github.com/cdr/code-server/discussions/3933)) + ## Workflow The workflow used by code-server maintainers aims to be easy to understood by From 2c6a47d42b1deee7004bb0dfd59218ff93fcf7c6 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 23 Sep 2021 12:24:08 -0700 Subject: [PATCH 4/5] docs(maintaining): add note for each release platform --- docs/MAINTAINING.md | 63 +++++++++++++++++++++++++++++++++------------ 1 file changed, 46 insertions(+), 17 deletions(-) diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index ccdfc33d7..822ab5ef9 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -1,24 +1,26 @@ - # Maintaining -- [Maintaining](#maintaining) - - [Team](#team) - - [Onboarding](#onboarding) - - [Offboarding](#offboarding) - - [Workflow](#workflow) - - [Milestones](#milestones) - - [Triage](#triage) - - [Project boards](#project-boards) - - [Versioning](#versioning) - - [Pull requests](#pull-requests) - - [Merge strategies](#merge-strategies) - - [Changelog](#changelog) - - [Releases](#releases) - - [Publishing a release](#publishing-a-release) - - [Documentation](#documentation) - - [Troubleshooting](#troubleshooting) +- [Team](#team) + - [Onboarding](#onboarding) + - [Offboarding](#offboarding) +- [Workflow](#workflow) + - [Milestones](#milestones) + - [Triage](#triage) + - [Project boards](#project-boards) +- [Versioning](#versioning) +- [Pull requests](#pull-requests) + - [Merge strategies](#merge-strategies) + - [Changelog](#changelog) +- [Releases](#releases) + - [Publishing a release](#publishing-a-release) + - [AUR](#aur) + - [Docker](#docker) + - [Homebrew](#homebrew) + - [npm](#npm) +- [Documentation](#documentation) + - [Troubleshooting](#troubleshooting) @@ -184,6 +186,33 @@ If you're the current release manager, follow these steps: [cdr/code-server-aur](https://github.com/cdr/code-server-aur). 1. Wait for the npm package to be published. +#### AUR + +We publish to AUR as a package [here](https://aur.archlinux.org/packages/code-server/). This process is manual and can be done by following the steps in [this repo](https://github.com/cdr/code-server-aur). + +#### Docker + +We publish code-server as a Docker image [here](https://registry.hub.docker.com/r/codercom/code-server), tagging it both with the version and latest. + +This is currently automated with the release process. + +#### Homebrew + +We publish code-server on Homebrew [here](https://github.com/Homebrew/homebrew-core/blob/master/Formula/code-server.rb). + +This is currently automated with the release process (but may fail occassionally). If it does, run this locally: + +```shell +# Replace VERSION with version +brew bump-formula-pr --version="${VERSION}" code-server --no-browse --no-audit +``` + +#### npm + +We publish code-server as an npm package [here](https://www.npmjs.com/package/code-server/v/latest). + +This is currently automated with the release process. + ## Documentation ### Troubleshooting From c91033c61119765f8b56a851c4651b2ede544298 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 23 Sep 2021 12:25:49 -0700 Subject: [PATCH 5/5] docs(maintaining): fix #4174 --- docs/MAINTAINING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index 822ab5ef9..a131c73a5 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -51,7 +51,7 @@ To onboard a new maintainer to the project, please make sure to do the following Very similar to Onboarding but Remove maintainer from all teams and revoke access. Please also do the following: -- [ ] Write fairwell post via Discussion (see [example](https://github.com/cdr/code-server/discussions/3933)) +- [ ] Write farewell post via Discussion (see [example](https://github.com/cdr/code-server/discussions/3933)) ## Workflow @@ -164,6 +164,7 @@ If you're the current release manager, follow these steps: ### Publishing a release +1. Create a release branch called `v0.0.0` but replace with new version 1. Run `yarn release:prep` and type in the new version (e.g., `3.8.1`) 1. GitHub Actions will generate the `npm-package`, `release-packages` and `release-images` artifacts. You do not have to wait for this step to complete @@ -209,7 +210,7 @@ brew bump-formula-pr --version="${VERSION}" code-server --no-browse --no-audit #### npm -We publish code-server as an npm package [here](https://www.npmjs.com/package/code-server/v/latest). +We publish code-server as a npm package [here](https://www.npmjs.com/package/code-server/v/latest). This is currently automated with the release process.