Skip to content

Commit ecea7f4

Browse files
Merge pull request #1386 from github/elenatanasoiu/update-release-docs
Follow guidance for git tagging in contribution docs
2 parents c368424 + 0b15a16 commit ecea7f4

1 file changed

Lines changed: 21 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,15 +115,34 @@ From inside of VSCode, open the `launch.json` file and in the _Launch Integratio
115115
* Create a new commit with a message the same as the branch name.
116116
* Create a PR for this branch.
117117
* Wait for the PR to be merged into `main`
118-
1. Trigger a release build on Actions by adding a new tag on branch `main` named after the release, as above. Note that when you push to upstream, you will need to fully qualify the ref. A command like this will work:
118+
1. Switch to `main` and add a new tag on the `main` branch with your new version (named after the release), e.g.
119+
```bash
120+
git checkout main
121+
git tag v1.3.6
122+
```
123+
124+
If you've accidentally created a badly named tag, you can delete it via
125+
```bash
126+
git tag -d badly-named-tag
127+
```
128+
1. Push the new tag up:
129+
130+
a. If you're using a fork of the repo:
119131

120132
```bash
121133
git push upstream refs/tags/v1.3.6
122134
```
135+
136+
b. If you're working straight in this repo:
137+
138+
```bash
139+
git push origin refs/tags/v1.3.6
140+
```
141+
142+
This will trigger [a release build](https://github.com/github/vscode-codeql/releases) on Actions.
123143
124144
* **IMPORTANT** Make sure you are on the `main` branch and your local checkout is fully updated when you add the tag.
125145
* If you accidentally add the tag to the wrong ref, you can just force push it to the right one later.
126-
127146
1. Monitor the status of the release build in the `Release` workflow in the Actions tab.
128147
1. Download the VSIX from the draft GitHub release at the top of [the releases page](https://github.com/github/vscode-codeql/releases) that is created when the release build finishes.
129148
1. Unzip the `.vsix` and inspect its `package.json` to make sure the version is what you expect,

0 commit comments

Comments
 (0)