GHA to create a release #32
Conversation
| name: Create GitHub Release for Extension Package | ||
|
|
||
| on: | ||
| workflow_dispatch: |
There was a problem hiding this comment.
One thing we could do here, which is currently hard-coded below, is give an input field to the workflow, that would allow the initiating user to create the description associated with the GitHub Release. Could be a nice way to make the "release notes" applicable to each release. Easy to do.
.github/workflows/create_release.yml
Outdated
| - name: Build VSIX Package | ||
| run: npx vsce package | ||
|
|
||
| - name: Get package version |
There was a problem hiding this comment.
Realizing after doing more of this script, that I could just inline this specific step to the "Create release" step below. I'll make that update, as I think that will be cleaner.
.github/workflows/create_release.yml
Outdated
| const packageName = packageJson.name; | ||
| const packageVersion = packageJson.version; | ||
| const vsixFilename = `${packageName}-${packageVersion}.vsix`; | ||
| const uploadUrl = await github.rest.repos.uploadReleaseAsset({ |
There was a problem hiding this comment.
nit: Do we need uploadUrl if we're not returning its property, something like we co in Create Release with return response.data.id?
There was a problem hiding this comment.
Ah, good catch. No. I had started this script anticipating more steps to come after, then didn't do that. I'll take it out.
.github/workflows/create_release.yml
Outdated
| return response.data.id; | ||
| - name: Attach VSIX package to release |
There was a problem hiding this comment.
nit nit: Missing newline since other steps are delineated by single line space in between.
There was a problem hiding this comment.
Haha I was just counting on the code formatting to fix that kind of stuff for me! I guess not. 😆 Good catch!
|
Gonna merge this and see if it works. It worked in a sandbox environment I used for coding it up, so 🤞. Happy to make iterations as we go. |
|
|
||
| 4. Manually install the generated .vsix file and smoke test. | ||
| **NOTE:** The packaging workflow prunes the dev dependencies out of the `node_modules/` tree, so you'll need to re-run `npm install` to reinstall dev dependencies and continue development work. |
There was a problem hiding this comment.
Do you want to remove this since other PR removes the pruning now?
There was a problem hiding this comment.
Oh thanks. 😊 Yeah, I'll remove it.
There was a problem hiding this comment.
Oops I just realized I already merged this. I'll get it in the open one!
First step to publishing! This creates a GitHub Action that will be manually triggered from the Actions tab. When run, this action will create a GitHub release on the repo, based on the package version in
package.json. It will then build the VSIX package, and attach that package to the release as an artifact.