Skip to content

Commit 900c34c

Browse files
authored
Merge pull request #4234 from cdr/jsjoeio/update-npm-maintainence
docs(MAINTAINING): update release section + add team section
2 parents f3ef414 + c91033c commit 900c34c

File tree

1 file changed

+57
-3
lines changed

1 file changed

+57
-3
lines changed

docs/MAINTAINING.md

+57-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
33
# Maintaining
44

5+
- [Team](#team)
6+
- [Onboarding](#onboarding)
7+
- [Offboarding](#offboarding)
58
- [Workflow](#workflow)
69
- [Milestones](#milestones)
710
- [Triage](#triage)
@@ -12,20 +15,43 @@
1215
- [Changelog](#changelog)
1316
- [Releases](#releases)
1417
- [Publishing a release](#publishing-a-release)
18+
- [AUR](#aur)
19+
- [Docker](#docker)
20+
- [Homebrew](#homebrew)
21+
- [npm](#npm)
1522
- [Documentation](#documentation)
1623
- [Troubleshooting](#troubleshooting)
1724

1825
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1926

27+
This document is meant to serve current and future maintainers of code-server,
28+
as well as share our workflow for maintaining the project.
29+
30+
## Team
31+
2032
Current maintainers:
2133

2234
- @code-asher
2335
- @TeffenEllis
24-
- @oxy
2536
- @jsjoeio
2637

27-
This document is meant to serve current and future maintainers of code-server,
28-
as well as share our workflow for maintaining the project.
38+
Occassionally, other Coder employees may step in time to time to assist with code-server.
39+
40+
### Onboarding
41+
42+
To onboard a new maintainer to the project, please make sure to do the following:
43+
44+
- [ ] Add to [cdr/code-server-reviewers](https://github.com/orgs/cdr/teams/code-server-reviewers)
45+
- [ ] Add as Admin under [Repository Settings > Access](https://github.com/cdr/code-server/settings/access)
46+
- [ ] Add to [npm Coder org](https://www.npmjs.com/org/coder)
47+
- [ ] Add as [AUR maintainer](https://aur.archlinux.org/packages/code-server/) (talk to Colin)
48+
- [ ] Introduce to community via Discussion (see [example](https://github.com/cdr/code-server/discussions/3955))
49+
50+
### Offboarding
51+
52+
Very similar to Onboarding but Remove maintainer from all teams and revoke access. Please also do the following:
53+
54+
- [ ] Write farewell post via Discussion (see [example](https://github.com/cdr/code-server/discussions/3933))
2955

3056
## Workflow
3157

@@ -138,6 +164,7 @@ If you're the current release manager, follow these steps:
138164

139165
### Publishing a release
140166

167+
1. Create a release branch called `v0.0.0` but replace with new version
141168
1. Run `yarn release:prep` and type in the new version (e.g., `3.8.1`)
142169
1. GitHub Actions will generate the `npm-package`, `release-packages` and
143170
`release-images` artifacts. You do not have to wait for this step to complete
@@ -160,6 +187,33 @@ If you're the current release manager, follow these steps:
160187
[cdr/code-server-aur](https://github.com/cdr/code-server-aur).
161188
1. Wait for the npm package to be published.
162189

190+
#### AUR
191+
192+
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).
193+
194+
#### Docker
195+
196+
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.
197+
198+
This is currently automated with the release process.
199+
200+
#### Homebrew
201+
202+
We publish code-server on Homebrew [here](https://github.com/Homebrew/homebrew-core/blob/master/Formula/code-server.rb).
203+
204+
This is currently automated with the release process (but may fail occassionally). If it does, run this locally:
205+
206+
```shell
207+
# Replace VERSION with version
208+
brew bump-formula-pr --version="${VERSION}" code-server --no-browse --no-audit
209+
```
210+
211+
#### npm
212+
213+
We publish code-server as a npm package [here](https://www.npmjs.com/package/code-server/v/latest).
214+
215+
This is currently automated with the release process.
216+
163217
## Documentation
164218

165219
### Troubleshooting

0 commit comments

Comments
 (0)