OCram85/code-server
Archived
1
0
Fork 0
Code Pull Requests 2 Activity

Add doc/guide.md

Browse Source
This commit is contained in:
Anmol Sethi
2020-05-14 03:17:17 -04:00
parent f4a78587b0
commit a0a77e379e
11 changed files with 537 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
ci/README.md
View File

@ -10,19 +10,19 @@ Any file and directory added into this tree should be documented here.
Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub) installed.
1. Update the version of code-server in `package.json` and README.md install examples and push a commit
1. GitHub actions will generate the `npm-package` and `release-packages` artifacts
1. Run `yarn release:github-draft` to create a GitHub draft release from the template with
1. Update the version of code-server in `package.json` and README.md/guide.md install examples and push a commit
2. GitHub actions will generate the `npm-package` and `release-packages` artifacts
3. 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. Wait for the artifacts in step 2 to build
1. Run `yarn release:github-assets` to download the artifacts and then upload them to the draft release
1. Run some basic sanity tests on one of the released packages
1. Publish the release
4. Wait for the artifacts in step 2 to build
5. Run `yarn release:github-assets` to download the artifacts and then upload them to the draft release
6. Run some basic sanity tests on one of the released packages
7. Publish the release
1. CI will automatically grab the artifacts and then
1. Publish the NPM package
1. Publish the AMD64 docker image
1. Publish the ARM64 docker image
2. Publish the AMD64 docker image
3. Publish the ARM64 docker image
## dev

3
ci/dev/fmt.sh
View File

@ -21,6 +21,9 @@ main() {
)
prettier --write --loglevel=warn $(git ls-files "${prettierExts[@]}")
doctoc --title '# FAQ' doc/FAQ.md > /dev/null
doctoc --title '# Setup Guide' doc/guide.md > /dev/null
if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
echo "Files need generation or are formatted incorrectly:"
git -c color.ui=always status | grep --color=no '\[31m'