Add infrastructure to release/publish as part of CI #22
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marcdumais-work
force-pushed
the
publish
branch
7 times, most recently
from
1a164ce to
be3d9b3
Compare
marcdumais-work
changed the title
marcdumais-work
force-pushed
the
publish
branch
5 times, most recently
from
a3c6b6b to
5fb2399
Compare
The added infrastructure is similar to what we recently added in the vscode-trace-extension repo. The idea is to automate creating a GitHub release and corresponding git tag, as well as the publishing to vscode extension registries (open-vsx.org to start-with). To achieve that, a new GitHub workflow was created: "release", that uses action "pipe-cd/actions-gh-release" to automatically create a GitHub release containing release notes generated from commits and a git tag. The trigger for that to happen is the modification of root file "RELEASE" to include a new release tag. We also renamed workflow "build" to "ci-cd" and updated it. It now has a publish job, that triggers upon a new release being created, and publishes the extension in "vsix" format to open-vsx.org. To prepare for the first release/publish, we also updated the extension's README, factoring-out the developer-centric information to its own file and keeping a minimal first draft of the README that will be shown to the end-users on the extension registry and in the extensions view. Also updated the extension's package.json to have the necessary fields and information, for a published extension. Once this is merged, if everything works as expected, all that will be needed for a first release will be to update the tag in file RELEASE to the release version and update the extension's version in package.json to the same. See below for some more info about the changes made, that were squashed into this single commit. add release workflow Add initial RELEASE file It's used by action pipe-cd/actions-gh-release . It will also require the initial tag in the git repo, which I will add separately. massage package.json add icon for extension For now reusing the same one as vscode-trace-extension Add format check scripts and run in workflow yarn format:check runs prettier on the sources and makes sure it's presentable README update Split the README into README-dev.md for developers and README.md for users. The later will be included and shown on the extension registry and in the extensions view, when the extension is selected. Signed-off-by: Marc Dumais <[email protected]>
marcdumais-work
force-pushed
the
publish
branch
from
5fb2399 to
f183ad3
Compare
bhufmann
requested changes
Feb 7, 2024
|
@bhufmann I have pushed a new commit, following your comments above. |
Signed-off-by: Marc Dumais <[email protected]>
marcdumais-work
force-pushed
the
publish
branch
from
0f040b0 to
46ebcc9
Compare
|
@bhufmann the remaining typo should now be corrected. |
|
Thanks for the review! I will follow-up with a small PR to trigger the first release of this extension. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The added infrastructure is similar to what we recently added in the vscode-trace-extension repo. The idea is to automate creating a GitHub release and corresponding git tag, as well as the publishing to vscode extension registries (open-vsx.org to start-with).
To achieve that, a new GitHub workflow was created: "release", that uses action "pipe-cd/actions-gh-release" to automatically create a GitHub release containing release notes generated from commits and a git tag. The trigger for that to happen is the modification of root file "RELEASE" to include a new release tag.
We also renamed workflow "build" to "ci-cd" and updated it. It now has a
publish job, that triggers upon a new release being created, and publishes the extension in "vsix" format to open-vsx.org.
To prepare for the first release/publish, we also updated the extension's README factoring-out the developer-centric information to its own file and keeping a minimal first draft of the README that will be shown to the end-users on the extension registry and in the extensions view. Also updated the extension's package.json to have the necessary fields and information, for a published extension.
Note: job "Create or prepare GitHub release / GitHub release" is expected to fail at this time, because it can't yet find file "RELEASE" in the main branch.