chore(docs): update courses flight manual (#46587)

pull/46595/head
Shaun Hamilton 2022-06-20 15:24:27 +01:00 committed by GitHub
parent 330d14a156
commit e9aaff5fd1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 22 deletions

View File

@ -4,41 +4,33 @@ This details the maintenance guidelines for the [freeCodeCamp/courses-vscode-ext
## Publishing the Extension
A GitHub Action automagically publishes the extension to the Visual Studio Marketplace, on pushes to the `prod` branch.
A GitHub Action automagically publishes the extension to the Visual Studio Marketplace, on the release of a new GitHub Release.
Ensure the `main` branch is checked out.
1. Package a new version of the extension:
```bash
git checkout main
npm run pack -- <tag_type>
```
Update the local repository with `upstream`, and reset `main`.
Where `<tag_type>` is one of: `major`, `minor`, `patch`.
2. Push the new version to `main`:
```bash
git fetch upstream
git reset --hard upstream/main
git commit -am "<tag_type>(<version>): <description>"
git push
```
Checkout the `prod` branch.
Optionally, you can push directly to `upstream/main`, but opening a new PR is recommended for a sanity check.
```bash
git checkout prod
```
3. Create a new GitHub Release using the GitHub UI:
Merge the commits wanted for deployment into `prod`.
```bash
git merge main
```
Push the local branch to `upstream`.
```bash
git push upstream
```
- Correctly increment the version number, when creating a new tag.
- Upload the `.vsix` file with the release.
- Publish the release, and confirm the action succeeded.
> [!NOTE]
> Pushing to `upstream` requires write access to the `freeCodeCamp/courses-vscode-extension` repository.
> Creating a release requires write access to the `freeCodeCamp/courses-vscode-extension` repository.
## Manually Publishing the Extension