Skip to content

Commit 7a48cc0

Browse files
committed
Fix violations in releasing doc
1 parent c86dcaf commit 7a48cc0

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

docs/releasing.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,26 @@
2222
* Create a PR for this branch.
2323
* Wait for the PR to be merged into `main`
2424
1. Switch to `main` branch and pull latest changes
25-
1. Lock the `main` branch.
25+
1. Lock the `main` branch.
2626
* Go to the [branch protection rules for the `main` branch](https://github.com/github/vscode-codeql/settings/branch_protection_rules/16447115)
2727
* Select "Lock branch"
2828
* Click "Save changes"
2929
1. Ensure that no PRs have been merged since the release PR that you merged. If there were, you might need to unlock `main` temporarily and update the CHANGELOG again.
3030
1. Build the extension `npm run build` and install it on your VS Code using "Install from VSIX".
3131
1. Go through [our test plan](./test-plan.md) to ensure that the extension is working as expected.
3232
1. Switch to `main` and add a new tag on the `main` branch with your new version (named after the release), e.g.
33+
3334
```bash
3435
git checkout main
3536
git tag v1.3.6
3637
```
3738

3839
If you've accidentally created a badly named tag, you can delete it via
39-
```bash
40-
git tag -d badly-named-tag
41-
```
40+
41+
```bash
42+
git tag -d badly-named-tag
43+
```
44+
4245
1. Unlock the main branch
4346
* Go to the [branch protection rules for the `main` branch](https://github.com/github/vscode-codeql/settings/branch_protection_rules/16447115)
4447
* Deselect "Lock branch"
@@ -68,7 +71,7 @@
6871
or look at the source if there's any doubt the right code is being shipped.
6972
1. Install the `.vsix` file into your vscode IDE and ensure the extension can load properly. Run a single command (like run query, or add database).
7073
1. Go to the actions tab of the vscode-codeql repository and select the [Release workflow](https://github.com/github/vscode-codeql/actions?query=workflow%3ARelease).
71-
- If there is an authentication failure when publishing, be sure to check that the authentication keys haven't expired. See below.
74+
* If there is an authentication failure when publishing, be sure to check that the authentication keys haven't expired. See below.
7275
1. Approve the deployments of the correct Release workflow. This will automatically publish to Open VSX and VS Code Marketplace.
7376
1. Go to the draft GitHub release in [the releases tab of the repository](https://github.com/github/vscode-codeql/releases), click 'Edit', add some summary description, and publish it.
7477
1. Confirm the new release is marked as the latest release at <https://github.com/github/vscode-codeql/releases>.

0 commit comments

Comments
 (0)