Skip to content

Commit c6bcc44

Browse files
committed
πŸ“š DOCS: Update publishing steps
1 parent d44aed6 commit c6bcc44

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

β€Ž.github/workflows/ci.ymlβ€Ž

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ name: CI
44
on:
55
push:
66
branches: [master, ci-*]
7+
tags:
8+
- "v[0-9]+.[0-9]+.[0-9]+*"
79
pull_request:
810
branches: [master]
911

@@ -65,9 +67,9 @@ jobs:
6567

6668
publish:
6769
# only if all tests complete and the commit is tagged as a release
68-
name: Publish to Marketplace
70+
name: Publish to VS Code Marketplace
6971
needs: [lint, tests]
70-
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') && contains(github.ref, 'release')
72+
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') && contains(github.ref, 'v')
7173
runs-on: ubuntu-latest
7274
steps:
7375
- uses: actions/checkout@v2

β€ŽREADME.mdβ€Ž

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,14 +171,13 @@ $ npm run lint:fix
171171

172172
### Publishing to VS Marketplace
173173

174-
The publishing of the package should be done *via* the Github Actions CI.
175-
To trigger a release:
174+
The publishing of the package should be done *via* the Github Actions CI:
176175

177176
1. Bump the version with npm, e.g. `npm version patch -m "πŸš€ RELEASE: v%s"` (major/minor/patch based on [semantic versioning](https://semver.org/))
178177
2. Push the commit and tag generated by npm (`git push --follow-tags`)
179-
3. Create a new release tag on Github starting with `release`, e.g. `release-0.9.4`.
178+
3. This should trigger the CI action and the `publish` step, check it runs correctly.
180179

181-
See also: <https://code.visualstudio.com/api/working-with-extensions/publishing-extension#publishing-extensions>
180+
See also: <https://code.visualstudio.com/api/working-with-extensions/publishing-extension#publishing-extensions>, and the [ExecutableBookProject publisher organization](https://dev.azure.com/ExecutableBookProject).
182181

183182
## Acknowledgements
184183

0 commit comments

Comments
Β (0)