Add workflows for drafting and publishing a release #631
Conversation
|
Token was added to This enables us to cut releases in a single step/workflow. Changelog in Marketplace entry is sourced automatically from We can also continue copy-pasting the relevant part of changelog into GitHub Release notes. Lastly we should not need to continue publishing the vsix to GitHub as this encourages a bad practice of users installing released extension outside of Marketplace.
Depends on: |
865047b to
15ea39d
Compare
Changelog in Marketplace entry is sourced automatically from Changelog.md We can continue updating that changelog manually. We can also continue copy-pasting the relevant part of changelog into GitHub Release notes. We can use Linux instead of Windows since Windows is not a requirement for vsce. Lastly we de-ephasise the vsix package as an artifact which can still be found and used but ideally we want folks to install from the Marketplace. This is a compromise between stopping publishing of vsix entirely vs automatically creating a release to which we'd upload it as an asset.
|
@jpogran As discussed via Slack I made some further adjustments which I also documented in the commit log. The release can now be triggered by tag push, although it's expected that we'd still manually create the GitHub Release - which can be done either as part of cutting the release and creating the tag (via GitHub web UI), or manually afterwards. I also decided to still package the vsix and upload it as an artifact, which is purposefully harder to find (compared to being a release asset). This aligns with the goal that we want folks to install the extension from the Marketplace. This is a compromise between stopping publishing of the vsix entirely and automatically creating a release to which we'd upload it as an asset. We can revisit this decision and either phase it out entirely (if nobody asks for it), or find a different solution. I ran into some unrelated problems when trying to test this in a fork and describes some steps that would make it easier in #786 |
|
👍🏼 to revisiting automatically creating a Github release, there is alot we can bike shed with that. Ideally we could create the release with a section of our changelog, which would compliment the marketplace display. Right now automating the changelog would be non-trivial, maybe with things like github/roadmap#248 that will be easier. |
FWIW the Marketplace already sources the changelog automatically from |
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. |
Depends on
~1.0#777This could all be combined into one workflow if we have an automated way to parse the changelog into release notes.
This is pending as a draft until we have the token available.