Skip to content

Commit eebc159

Browse files
authored
update publishing docs (#569)
1 parent dce0763 commit eebc159

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

docs/publish-extension.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,26 @@ release.
3131
```
3232

3333
9. Push the release branch and open a pull request using the new changelog entry as the PR description
34-
10. Generate a release candidate vsix file with `npm run package`, the vsix file should appear in the `./client` folder with the new version number
3534

36-
> WARNING: ensure .env file is populated with GA and Sentry secrets before packaging (see `./env.example`)
35+
10. Ensure .env file is populated with GA and Sentry secrets before packaging (see `./env.example`)
3736

38-
11. Manually run smoke tests on the new features across:
37+
11. Generate a release candidate vsix file with `npm run package`, the vsix file should appear in the `./client` folder with the new version number
38+
39+
12. Manually run smoke tests on the new features across:
3940

4041
- mac os x
4142
- windows
4243
- vscode running against docker
4344

44-
12. On a successful check, `rebase merge` the release branch into main
45-
13. Switch to main branch and pull the latest changes
46-
14. Git tag the version, `g tag -a v0.x.x -m "v0.x.x"` and push the tag `git push --follow-tags`
47-
15. Publish the language server npm package, `cd ./server && npm publish`
48-
16. Publish the coc extension, `cd ./coc && npm publish --non-interactive`
49-
17. Upload the vsix file to the microsoft marketplace: `npx vsce publish -p $VSCE_TOKEN --packagePath client/hardhat-solidity-0.X.X.vsix`
50-
18. Upload the vsix file to openvsx, `npx ovsx publish client/hardhat-solidity-0.X.X.vsix -p $OVSX_TOKEN`
51-
19. Create a release on github off of the pushed tag
45+
13. Ensure that metrics are reported correctly in both Google Analytics and Sentry for the new version.
46+
14. On a successful check, `rebase merge` the release branch into main
47+
15. Switch to main branch and pull the latest changes
48+
16. Git tag the version, `git tag -a v0.x.x -m "v0.x.x"` and push the tag `git push --follow-tags`
49+
17. Publish the language server npm package, `cd ./server && npm publish`
50+
18. Publish the coc extension, `cd ./coc && npm publish --non-interactive`
51+
19. Upload the vsix file to the microsoft marketplace: `npx vsce publish -p $VSCE_TOKEN --packagePath client/hardhat-solidity-0.X.X.vsix`
52+
20. Upload the vsix file to openvsx, `npx ovsx publish client/hardhat-solidity-0.X.X.vsix -p $OVSX_TOKEN`
53+
21. Create a release on github off of the pushed tag
5254

5355
- use the added changelog section as the body of the release
5456
- append the Nomic is Hiring section to the end of the release not:
@@ -61,8 +63,8 @@ release.
6163

6264
- upload the vsix file as an asset
6365

64-
18. Rebase `development` onto `main`, and force push back to github
65-
19. Update the discord announcements channel
66+
22. Rebase `development` onto `main`, and force push back to github
67+
23. Update the discord announcements channel
6668

6769
- link to the release entry on github (i.e. `https://github.com/NomicFoundation/hardhat-vscode/releases/tag/v0.x.x`)
6870
- give a few sentences of description of why users should be excited about this release

0 commit comments

Comments
 (0)