From 2c6a47d42b1deee7004bb0dfd59218ff93fcf7c6 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 23 Sep 2021 12:24:08 -0700 Subject: [PATCH] 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