5afb26fb60
* fix(ci): correctly download npm artifact * fixup! fix(ci): correctly download npm artifact * docs: update MAINTAINING * fixup! docs: update MAINTAINING * fixup! Merge branch 'main' into 4949-chore-fix-npm-workflow * chore: get ci to run * refactor: use vVERSION branch name instead of release * refactor: use new download artifact in docker workflow * refactor: clean up release-github-assets script * fixup: remove extra v * fixup! fixup: remove extra v
256 lines
10 KiB
Markdown
256 lines
10 KiB
Markdown
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
# 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)
|
|
- [AUR](#aur)
|
|
- [Docker](#docker)
|
|
- [Homebrew](#homebrew)
|
|
- [npm](#npm)
|
|
- [Syncing with Upstream VS Code](#syncing-with-upstream-vs-code)
|
|
- [Testing](#testing)
|
|
- [Documentation](#documentation)
|
|
- [Troubleshooting](#troubleshooting)
|
|
|
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
|
|
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
|
|
- @jsjoeio
|
|
|
|
Occasionally, 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 [coder/code-server-reviewers](https://github.com/orgs/coder/teams/code-server-reviewers)
|
|
- [ ] Add as Admin under [Repository Settings > Access](https://github.com/coder/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/coder/code-server/discussions/3955))
|
|
|
|
### Offboarding
|
|
|
|
Very similar to Onboarding but Remove maintainer from all teams and revoke access. Please also do the following:
|
|
|
|
- [ ] Write farewell post via Discussion (see [example](https://github.com/coder/code-server/discussions/3933))
|
|
|
|
## Workflow
|
|
|
|
The workflow used by code-server maintainers aims to be easy to understood by
|
|
the community and easy enough for new maintainers to jump in and start
|
|
contributing on day one.
|
|
|
|
### Milestones
|
|
|
|
We operate mainly using
|
|
[milestones](https://github.com/coder/code-server/milestones). This was heavily
|
|
inspired by our friends over at [vscode](https://github.com/microsoft/vscode).
|
|
|
|
Here are the milestones we use and how we use them:
|
|
|
|
- "Backlog" -> Work not yet planned for a specific release.
|
|
- "On Deck" -> Work under consideration for upcoming milestones.
|
|
- "Backlog Candidates" -> Work that is not yet accepted for the backlog. We wait
|
|
for the community to weigh in.
|
|
- "<0.0.0>" -> Work to be done for a specific version.
|
|
|
|
With this flow, any un-assigned issues are essentially in triage state. Once
|
|
triaged, issues are either "Backlog" or "Backlog Candidates". They will
|
|
eventually move to "On Deck" (or be closed). Lastly, they will end up on a
|
|
version milestone where they will be worked on.
|
|
|
|
### Triage
|
|
|
|
We use the following process for triaging GitHub issues:
|
|
|
|
1. Create an issue
|
|
1. Add appropriate labels to the issue (including "needs-investigation" if we
|
|
should look into it further)
|
|
1. Add the issue to a milestone
|
|
1. If it should be fixed soon, add to version milestone or "On Deck"
|
|
2. If not urgent, add to "Backlog"
|
|
3. Otherwise, add to "Backlog Candidate" for future consideration
|
|
|
|
### Project boards
|
|
|
|
We use project boards for projects or goals that span multiple milestones.
|
|
|
|
Think of this as a place to put miscellaneous things (like testing, clean up
|
|
stuff, etc). As a maintainer, random tasks may come up here and there. The
|
|
project boards give you places to add temporary notes before opening a new
|
|
issue. Given that our release milestones function off of issues, we believe
|
|
tasks should have dedicated issues.
|
|
|
|
Project boards also give us a way to separate the issue triage from
|
|
bigger-picture, long-term work.
|
|
|
|
## Versioning
|
|
|
|
`<major.minor.patch>`
|
|
|
|
The code-server project follows traditional [semantic
|
|
versioning](https://semver.org/), with the objective of minimizing major changes
|
|
that break backward compatibility. We increment the patch level for all
|
|
releases, except when the upstream Visual Studio Code project increments its
|
|
minor version or we change the plugin API in a backward-compatible manner. In
|
|
those cases, we increment the minor version rather than the patch level.
|
|
|
|
## Pull requests
|
|
|
|
Ideally, every PR should fix an issue. If it doesn't, make sure it's associated
|
|
with a version milestone.
|
|
|
|
If a PR does fix an issue, don't add it to the version milestone. Otherwise, the
|
|
version milestone will have duplicate information: the issue and the PR fixing
|
|
the issue.
|
|
|
|
### Merge strategies
|
|
|
|
For most things, we recommend the **squash and merge** strategy. There
|
|
may be times where **creating a merge commit** makes sense as well. Use your
|
|
best judgment. If you're unsure, you can always discuss in the PR with the team.
|
|
|
|
### Changelog
|
|
|
|
To save time when creating a new release for code-server, we keep a running
|
|
changelog at `CHANGELOG.md`.
|
|
|
|
If either the author or reviewer of a PR believes the change should be mentioned
|
|
in the changelog, then it should be added.
|
|
|
|
If there is not a **Next Version** when you modify `CHANGELOG.md`, please add it
|
|
using the template you see near the top of the changelog.
|
|
|
|
When writing your changelog item, ask yourself:
|
|
|
|
1. How do these changes affect code-server users?
|
|
2. What actions do they need to take (if any)?
|
|
|
|
If you need inspiration, we suggest looking at the [Emacs
|
|
changelog](https://github.com/emacs-mirror/emacs/blob/master/etc/NEWS).
|
|
|
|
## Releases
|
|
|
|
With each release, we rotate the role of release manager to ensure every
|
|
maintainer goes through the process. This helps us keep documentation up-to-date
|
|
and encourages us to continually review and improve the flow.
|
|
|
|
If you're the current release manager, follow these steps:
|
|
|
|
1. Create a [release issue](../.github/ISSUE_TEMPLATE/release.md)
|
|
1. Fill out checklist
|
|
1. Publish the release
|
|
1. After release is published, close release milestone
|
|
|
|
### Publishing a release
|
|
|
|
1. Create a new branch called `v0.0.0` (replace 0s with actual version aka v4.1.0)
|
|
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
|
|
before proceeding.
|
|
1. Run `yarn release:github-draft` to create a GitHub draft release from the
|
|
template with the updated version.
|
|
1. Summarize the major changes in the release notes and link to the relevant
|
|
issues.
|
|
1. Change the @ to target the version branch. Example: `v3.9.0 @ Target: v3.9.0`
|
|
1. Wait for the `npm-package`, `release-packages` and `release-images` artifacts
|
|
to build.
|
|
1. Run `yarn release:github-assets` to download the `release-packages` artifact.
|
|
They will upload them to the draft release.
|
|
1. Run some basic sanity tests on one of the released packages (pay special
|
|
attention to making sure the terminal works).
|
|
1. Publish the release and merge the PR. CI will automatically grab the
|
|
artifacts, publish the NPM package from `npm-package`, and publish the Docker
|
|
Hub image from `release-images`.
|
|
1. Update the AUR package. Instructions for updating the AUR package are at
|
|
[coder/code-server-aur](https://github.com/coder/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/coder/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 occasionally). 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 a npm package [here](https://www.npmjs.com/package/code-server/v/latest).
|
|
|
|
This is currently automated with the release process.
|
|
|
|
## Syncing with Upstream VS Code
|
|
|
|
The VS Code portion of code-server lives under [`coder/vscode`](https://github.com/coder/vscode). To update VS Code for code-server, follow these steps:
|
|
|
|
1. `git checkout -b vscode-update` - Create a new branch locally based off `main`
|
|
2. `git fetch upstream` - Fetch upstream (VS Code)'s latest branches
|
|
3. `git merge upstream/release/1.64` - Merge it locally
|
|
1. replace `1.64` with the version you're upgrading to
|
|
1. If there are merge conflicts, commit first, then fix them locally.
|
|
4. Open a PR merging your branch (`vscode-update`) into `main` and add the code-server review team
|
|
|
|
Ideally, our fork stays as close to upstream as possible. See the differences between our fork and upstream [here](https://github.com/microsoft/vscode/compare/main...coder:main).
|
|
|
|
## Testing
|
|
|
|
Our testing structure is laid out under our [Contributing docs](https://coder.com/docs/code-server/latest/CONTRIBUTING#test).
|
|
|
|
We hope to eventually hit 100% test coverage with our unit tests, and maybe one day our scripts (coverage not tracked currently).
|
|
|
|
If you're ever looking to add more tests, here are a few ways to get started:
|
|
|
|
- run `yarn test:unit` and look at the coverage chart. You'll see all the uncovered lines. This is a good place to start.
|
|
- look at `test/scripts` to see which scripts are tested. We can always use more tests there.
|
|
- look at `test/e2e`. We can always use more end-to-end tests.
|
|
|
|
Otherwise, talk to a current maintainer and ask which part of the codebase is lacking most when it comes to tests.
|
|
|
|
## Documentation
|
|
|
|
### Troubleshooting
|
|
|
|
Our docs are hosted on [Vercel](https://vercel.com/). Vercel only shows logs in realtime, which means you need to have the logs open in one tab and reproduce your error in another tab. Since our logs are private to Coder the organization, you can only follow these steps if you're a Coder employee. Ask a maintainer for help if you need it.
|
|
|
|
Taking a real scenario, let's say you wanted to troubleshoot [this docs change](https://github.com/coder/code-server/pull/4042). Here is how you would do it:
|
|
|
|
1. Go to https://vercel.com/codercom/codercom
|
|
2. Click "View Function Logs"
|
|
3. In a separate tab, open the preview link from github-actions-bot
|
|
4. Now look at the function logs and see if there are errors in the logs
|