Prepare for first release to OpenVSX #191

marcdumais-work · 2024-01-24T22:28:03Z

Prepare for first release on openvsx.org

Changes

Renamed the build workflow to ci-cd and made modifications:
- added a publish job, that publishes the .vsix extension to openvsx.org,
  triggered only when a release tag (v) is pushed to the repo.
- merged the build and ui tests jobs. They were redundent, both building
  the project
- removed yarn package caching: practically it helped very little, cutting
  only ~5% vs the time it takes to install the dependencies without
  ~(25s vs 26s) in the best case (cache hit). With a cache miss (run with
  modified yarn.lock), we had a 100%+ penalty, if we count the overhead
  of the cache being saved to GitHub infrastructure ("Post Cache..." job).
created a "release" workflow that uses "pipe-cd/actions-gh-release" to
create a release tag and corresponding GitHub release, when a change
is detected in root file "RELEASE".
- TL;DR: a new release is triggered by adding the tag value
  reflecting release version, to RELEASE file as part of a PR. The
  action will add tentative release notes to the PR that can be edited
  as needed. Upon merging the PR, a release tag will be created in the
  repo, which will trigger the publish job, that will eventually result
  in the new version of the extension being deployed to openvsx.org
- it looks like the RELEASE file must exist before its first use in a PR,
  so created one with no active content.
Added "doc/Publishing.md" to briefly document how to go about creating new
releases / publish new releases to openvsx.org
renamed public-facing name (displayName) of the extension to "Trace Viewer
for VSCode", to better reflect its nature
changed public-facing mentions of "vscode" to the canonical "VSCode"
changed extension's publisher, to align with the configuration of the CDT
Cloud OpenVSX publisher user: "eclipse-cdt". See:
https://www.open-vsx.org/namespace/eclipse-cdt
other misc updates to the extension's package.json: added/massaged important
fields
(https://www.open-vsx.org/namespace/eclipse-cdt).
kept developer-specific information in repo's root README.md but moved
generic information, useful to users of the extension, to extension's
README (which becomes the information page for the extension when published
or installed).
Added an icon for the extension. Though probably not the best ever, re-used
the one from repo "theia-trace-extension"

Notes

CI job "Create or prepare GitHub release" failing is normal at this time, because file ./RELEASE does not yet exist on master. Adding it in this PR will fix this for the future.
It's unfortunately not easy to test in advance the publish and release CI jobs. I plan to attempt a first release ASAP to try both, and may find then that some changes are needed.
The change in publisher to align with openvsx.org user for eclipse-cdt-cloud may cause momentary issues during the transition, e.g. if a user attempts to install the new version (with the new publisher) when the old one (with original publisher) is already installed. The fact that the extension was never published using the old publisher should mitigate these issues for ordinary end-users.
companion extension vscode-trace-server is not yet published. It would be ideal to also publish it to openvsx.org ASAP. It should be possible to do so very similarly as what was done in this PR.

Closes #69

vscode-trace-extension/README.md

bhufmann · 2024-01-26T19:12:30Z

.github/workflows/release.yml

+        branches:
+          - master
+        paths:
+          - 'RELEASE'


Will that run the release already when a pull request is created?

I think it will trigger the action but when it checks the RELEASE file it should immediately exit since there is no "tag" entry in the file yet.

Oops - I answered the wrong question, sorry.

When a new PR is created after this is merged, the action will add the automatically created release notes to the PR, leaving the opportunity to make changes if desired (e.g. by using more detailed options in file RELEASE). The GitHub release and release tag will only be created upon the/that PR being merged.

More info about how this action works:
https://github.com/pipe-cd/actions-gh-release#actions-gh-release

Thanks for the answer!

bhufmann · 2024-01-26T19:18:45Z

vscode-trace-extension/README.md

+
+For information about building this extension from sources, debugging, etc, please see [Developing.md](https://github.com/eclipse-cdt-cloud/vscode-trace-extension/tree/master/README.md)
+
+## Using the extension


For this PR, I think the documentation it sufficient. There other ways to open traces. As a follow-up, we should create a dedicated documentation file that is referenced here. The README in the "sister" Theia trace extension has more details: https://github.com/eclipse-cdt-cloud/theia-trace-extension/tree/master#using-the-trace-extension

I just noticed above a left-over, from a previous version of the PR: the mention of "Developing.md". I will correct this.

I have corrected the leftover above in the latest commit.

bhufmann

Looks good to me! Thanks for the contribution.

bhufmann · 2024-01-29T15:16:40Z

.github/workflows/release.yml

+        branches:
+          - master
+        paths:
+          - 'RELEASE'


Thanks for the answer!

- Renamed the build workflow to ci-cd and made modifications: - added a publish job, that publishes the .vsix extension to openvsx.org, triggered only when a release tag (v<something>) is pushed to the repo. - merged the build and ui tests jobs. They were redundent, both building the project - removed yarn package caching: practically it helped very little, cutting only ~5% vs the time it takes to install the dependencies without ~(25s vs 26s) in the best case (cache hit). With a cache miss (run with modified yarn.lock), we had a 100+% penalty, if we count the overhead of the cache being saved to GitHub infrastructure. - created a "release" workflow that uses "pipe-cd/actions-gh-release" to to create a release tag and corresponding GitHub release, when a change is detected in root file "RELEASE". - TL;DR: this is how a release is triggered, by adding the tag value reflecting release version, to RELEASE file as part of a PR. The action will add tentative release notes to the PR that can be edited as needed. Upon merging the PR, a release tag will be created in the repo, which will trigger the publish job, that will eventually result in the new version of the extension being deployed to openvsx.org - it looks like the RELEASE file must exist before its first use in a PR, so created one with no active content. - added "doc/Publishing.md" to briefly document how to go about creating new releases / publish new releases to openvsx.org - renamed public-facing name (displayName) of the extension to "Trace Viewer for VSCode", to better reflect its nature - changed public-facing mentions of "vscode" to the canonical "VSCode" - changed extension's publisher, to align with the configuration of the CDT Cloud OpenVSX publisher user: "eclipse-cdt". See: https://www.open-vsx.org/namespace/eclipse-cdt - other misc updates to the extension's package.json: added/massaged important fields (https://www.open-vsx.org/namespace/eclipse-cdt). - kept developer-specific information in repo's root README.md but moved generic information, useful to users of the extension, to extension's README (which becomes the information page for the extension when published or installed). - Added an icon for the extension. Though probably not the best ever, re-used the one from repo "theia-trace-extension" Closes #69 Signed-off-by: Marc Dumais <[email protected]>

Signed-off-by: Marc Dumais <[email protected]>

marcdumais-work · 2024-01-30T15:28:47Z

I just pushed a rebase on master

marcdumais-work force-pushed the publish-ovsx branch 30 times, most recently from 19b79a3 to ef71cfb Compare January 25, 2024 18:30

marcdumais-work force-pushed the publish-ovsx branch 3 times, most recently from d514beb to d9b823e Compare January 25, 2024 20:56

marcdumais-work changed the title ~~[WIP] Publish ovsx~~ [WIP] Prepare for first release to OpenVSX Jan 25, 2024

marcdumais-work force-pushed the publish-ovsx branch from d9b823e to d6c793e Compare January 25, 2024 21:11

marcdumais-work added the packaging and maintenance label Jan 25, 2024

marcdumais-work force-pushed the publish-ovsx branch from d6c793e to 23c283b Compare January 25, 2024 21:32

marcdumais-work marked this pull request as ready for review January 25, 2024 22:16

marcdumais-work requested review from bhufmann and PatrickTasse January 25, 2024 22:16

marcdumais-work force-pushed the publish-ovsx branch 7 times, most recently from 3087b38 to 52e07d9 Compare January 25, 2024 22:46

marcdumais-work changed the title ~~[WIP] Prepare for first release to OpenVSX~~ Prepare for first release to OpenVSX Jan 26, 2024

bhufmann requested changes Jan 26, 2024

View reviewed changes

marcdumais-work force-pushed the publish-ovsx branch from dd251be to fea8f12 Compare January 26, 2024 22:14

bhufmann approved these changes Jan 29, 2024

View reviewed changes

.github/workflows/release.yml

branches:

- master

paths:

- 'RELEASE'

Copy link

Collaborator

bhufmann Jan 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the answer!

marcdumais-work added 2 commits January 30, 2024 10:19

update extension's README according to review comments

d5083dd

Signed-off-by: Marc Dumais <[email protected]>

marcdumais-work force-pushed the publish-ovsx branch from fea8f12 to d5083dd Compare January 30, 2024 15:28

marcdumais-work merged commit 169000d into master Jan 30, 2024
4 of 6 checks passed

marcdumais-work deleted the publish-ovsx branch January 30, 2024 15:34

This was referenced Jan 30, 2024

Trigger first release to open-vsx.org: take 2 marcdumais-work/vscode-trace-extension#2

Closed

Trigger first release to open-vsx.org #194

Merged

bhufmann mentioned this pull request Feb 2, 2024

Register to vscode-trace-extension as a trace server contributor eclipse-cdt-cloud/vscode-trace-server#16

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prepare for first release to OpenVSX #191

Prepare for first release to OpenVSX #191

marcdumais-work commented Jan 24, 2024 •

edited

Loading

bhufmann Jan 26, 2024

marcdumais-work Jan 26, 2024

marcdumais-work Jan 26, 2024 •

edited

Loading

marcdumais-work Jan 26, 2024 •

edited

Loading

bhufmann Jan 29, 2024

bhufmann Jan 26, 2024

marcdumais-work Jan 26, 2024

marcdumais-work Jan 26, 2024

bhufmann left a comment

bhufmann Jan 29, 2024

marcdumais-work commented Jan 30, 2024


		For information about building this extension from sources, debugging, etc, please see [Developing.md](https://github.com/eclipse-cdt-cloud/vscode-trace-extension/tree/master/README.md)

		## Using the extension

Prepare for first release to OpenVSX #191

Prepare for first release to OpenVSX #191

Conversation

marcdumais-work commented Jan 24, 2024 • edited Loading

Prepare for first release on openvsx.org

Changes

Notes

bhufmann Jan 26, 2024

Choose a reason for hiding this comment

marcdumais-work Jan 26, 2024

Choose a reason for hiding this comment

marcdumais-work Jan 26, 2024 • edited Loading

Choose a reason for hiding this comment

marcdumais-work Jan 26, 2024 • edited Loading

Choose a reason for hiding this comment

bhufmann Jan 29, 2024

Choose a reason for hiding this comment

bhufmann Jan 26, 2024

Choose a reason for hiding this comment

marcdumais-work Jan 26, 2024

Choose a reason for hiding this comment

marcdumais-work Jan 26, 2024

Choose a reason for hiding this comment

bhufmann left a comment

Choose a reason for hiding this comment

bhufmann Jan 29, 2024

Choose a reason for hiding this comment

marcdumais-work commented Jan 30, 2024

marcdumais-work commented Jan 24, 2024 •

edited

Loading

marcdumais-work Jan 26, 2024 •

edited

Loading

marcdumais-work Jan 26, 2024 •

edited

Loading