From d0b41ba3f8efef5abf3e0845d1fc256aa82d8ad2 Mon Sep 17 00:00:00 2001 From: Marc Dumais Date: Tue, 30 Jan 2024 13:47:12 -0500 Subject: [PATCH] Trigger first release to open-vsx.org - Add new tag and some options related to automatic release notes generation to file RELEASE - Step extension's version - Have test setup not rely on hardcoded extension version in filename, by using a glob Signed-off-by: Marc Dumais --- .github/workflows/release.yml | 2 +- RELEASE | 14 +++++++++++++- doc/Publishing.md | 10 +++++----- package.json | 2 +- vscode-trace-extension/package.json | 2 +- 5 files changed, 21 insertions(+), 9 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 519ffcc2..95474fa4 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -22,7 +22,7 @@ jobs: - uses: actions/checkout@v3 with: fetch-depth: 0 - - uses: pipe-cd/actions-gh-release@v2.3.4 + - uses: pipe-cd/actions-gh-release@v2.6.0 with: release_file: 'RELEASE' token: ${{ secrets.GITHUB_TOKEN }} diff --git a/RELEASE b/RELEASE index 4a8cd4df..c73bcade 100644 --- a/RELEASE +++ b/RELEASE @@ -1 +1,13 @@ -tag: v0.0.0 +tag: v0.2.0 + +commitInclude: + parentOfMergeCommit: true + + +releaseNoteGenerator: + showAbbrevHash: true + showCommitter: true + useReleaseNoteBlock: false + usePullRequestLink: true + usePullRequestMetadata: false + diff --git a/doc/Publishing.md b/doc/Publishing.md index 72efc209..f3dd28da 100644 --- a/doc/Publishing.md +++ b/doc/Publishing.md @@ -5,12 +5,12 @@ The Github workflows are setup to make this relatively simple. When it's desired to have a new release: - open a Pull Request that steps the version of the extension in `vscode-trace-extension/package.json` -- As part of the PR, update file RELEASE \[1\] in the repo root. Add or modify it to reflect the new version-to-be-released. +- As part of the PR, update file RELEASE \[1\] in the repo root. Update the tag to match the one in package.json. e.g. - > tag: v0.1.0 # The tag number will be created. Required. + > tag: v0.2.1 -- The PR should be automatically updated, and automatically generated release noted added to it -- Upon merging the PR, the GH release will automatically be created, and the release notes added to document it. A release tag, for the new relase will also be created in the repo. -- The release tag should trigger a publish workflow that will build and release a new version of the extension to openvsx.org +- The PR should be automatically updated, and a preview of the automatically generated release noted, will be added in the form of a comment +- Upon merging the PR, the GH release will automatically be created, using the generated release notes. A git tag for the new release will also be created in the repo. If needed, a committer can edit to release. +- The creation of the release git tag should trigger a publish workflow that will build and release a new version of the extension to openvsx.org \[1\]: Here is the action that we use. For more details see its documentation: https://github.com/pipe-cd/actions-gh-release#actions-gh-release \ No newline at end of file diff --git a/package.json b/package.json index 9215ccda..a62daff9 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "start:server": "./trace-compass-server/tracecompass-server", "download:sample-traces": "curl -o TraceCompassTutorialTraces.tgz https://raw.githubusercontent.com/dorsal-lab/tracevizlab/master/labs/TraceCompassTutorialTraces.tgz; tar -xf TraceCompassTutorialTraces.tgz", "download:openvscode-server": "mkdir -p test-resources; cd test-resources; curl -L -o openvscode-server-v1.77.3-linux-x64.tar.gz https://github.com/gitpod-io/openvscode-server/releases/download/openvscode-server-v1.77.3/openvscode-server-v1.77.3-linux-x64.tar.gz; tar -xf openvscode-server-v1.77.3-linux-x64.tar.gz", - "configure:openvscode-server": "cd test-resources/openvscode-server-v1.77.3-linux-x64/bin/; sed -i 's;\"$@\".*$;\"$@\" --without-connection-token --install-extension $ROOT/../../vscode-trace-extension/vscode-trace-extension-0.1.0.vsix --default-folder=$ROOT/../../TraceCompassTutorialTraces --start-server;g' openvscode-server", + "configure:openvscode-server": "cd test-resources/openvscode-server-v1.77.3-linux-x64/bin/; sed -i 's;\"$@\".*$;\"$@\" --without-connection-token --install-extension $ROOT/../../vscode-trace-extension/vscode-trace-extension-*.vsix --default-folder=$ROOT/../../TraceCompassTutorialTraces --start-server;g' openvscode-server", "start:openvscode-server": "cd test-resources/openvscode-server-v1.77.3-linux-x64/bin/; ./openvscode-server ${0}", "license:check": "npx dash-licenses-wrapper --configFile=./configs/license-check-config.json", "license:check:review": "npx dash-licenses-wrapper --configFile=./configs/license-check-config.json --review" diff --git a/vscode-trace-extension/package.json b/vscode-trace-extension/package.json index 83e3c659..6c9a05e7 100644 --- a/vscode-trace-extension/package.json +++ b/vscode-trace-extension/package.json @@ -2,7 +2,7 @@ "name": "vscode-trace-extension", "displayName": "Trace Viewer for VSCode", "description": "Viewer that permits visualizing traces and contained data, analyzed by a trace server, and provided over the Trace Server Protocol (TSP)", - "version": "0.1.0", + "version": "0.2.0", "license": "MIT", "engines": { "vscode": "^1.52.0"