Skip to content

Add GitHub Actions workflow for automated release - #153

Open
adangel wants to merge 12 commits into
ChuckJonas:masterfrom
adangel:doc-releasing
Open

Add GitHub Actions workflow for automated release#153
adangel wants to merge 12 commits into
ChuckJonas:masterfrom
adangel:doc-releasing

Conversation

@adangel

@adangel adangel commented Sep 14, 2023

Copy link
Copy Markdown
Collaborator

This documents the release process and provides script snippets, that can be executed manually (when GitHub Actions isnt' available).

Additionally, three GitHub Actions workflows are provided:

  1. prepare-release: Can be triggered manually with providing a releaseVersion and a nextVersion. This updates the version, the changelog and creates a tag and finally creates a new draft release.
  2. publish-release: This is triggered, when the previously draft release is published. It will upload the extension to the marketplace.
  3. update-pmd: This updates PMD to the latest version and creates a new pull request.

Fixes #95

@adangel adangel changed the title Add RELEASING documentation Add GitHub Actions workflow for automated release Sep 14, 2023
@adangel
adangel marked this pull request as ready for review September 16, 2023 08:37
@adangel

adangel commented Sep 16, 2023

Copy link
Copy Markdown
Collaborator Author

This is ready now, but I didn't test the new workflows.... I guess, we would need to try them out for real, to see, if they work or not.

Note: the publish-release workflow needs a configured secret "VSCE_PAT" to be able to upload the extension.

Comment thread RELEASING.md
- Manual: Go to <https://marketplace.visualstudio.com/manage/publishers/chuckjonas>
- Using a script:
```shell
export VSCE_PAT=....

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
export VSCE_PAT=....
echo -n "Enter VSCE Access Token="
IFS= read -r VSCE_PAT
export VSCE_PAT

Comment thread RELEASING.md
8. Commit the changes to master branch.

```shell
git add --update

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
git add --update
npm run prettier
git add --update

Comment thread RELEASING.md
5. Commit the changes to master branch and create a new tag. The tag is `RELEASE_VERSION` prefixed with `v`.

```shell
git add --update

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
git add --update
npm run prettier
git add --update

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CI/CD and releasing

1 participant