Skip to content

Commit

Permalink
fix: CONTRIBUTING.md now explains our release workflow
Browse files Browse the repository at this point in the history
Adding "fix" to trigger a new version. Let's see if it actually
gets packaged automatically.
  • Loading branch information
iamsergio committed May 6, 2024
1 parent 851d51f commit baa4538
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Prepare your development environment

Just follow `.devcontainer/Dockerfile` to see what's needed.<br?>
Just follow `.devcontainer/Dockerfile` to see what's needed.<br>

## Build

Expand All @@ -14,15 +14,18 @@ code --install-extension qttest-0.3.0.vsix

## Running tests

In the docker, run `run_manual_test.sh` which will build the Qt project, the vscode extension
In the docker (or otherwise), run `run_manual_test.sh` which will build the Qt project, the vscode extension
and open vscode. It should show the test slots in the test explorer.<br>
Or just run the script locally.

## Commit

We use conventional commits. Prefix your commit message with `fix: `, `feat: ` or `chore: `
depending if it's a fix, a feature or misc change. This will be used for automatic changelog generation.

## Fixing bugs in the qttest-utils module

Most of the functionallity lives in a separate repo, [qttest-utils](https://github.com/KDAB/qttest-utils/), which is published to npm. After you fix a bug there, bump its version and publish it to npm, then you can edit `package.json` and bump the qttest-utils dependency version.


## Releasing

Expand All @@ -37,7 +40,9 @@ Changelog, version bump and tagging is done automatically by merging the release

## Publishing

After you did the release, go ahead and package:
Packaging is done automatically by the [package.yml](.github/workflows/package.yml) workflow. Which uploads
a package to the GitHub releases page. For example: https://github.com/KDAB/vscode-qttest/releases/tag/v1.8.4

If for some reason there's no *.vsix file under `assets`, you can trigger the workflow manually at https://github.com/KDAB/vscode-qttest/actions/workflows/package.yml

- npm install && npm run compile && npm prune --production && vsce package
- (KDAB only) Go to https://marketplace.visualstudio.com/manage/publishers/KDAB and upload the *.vsix file
After packaging is done, go to https://marketplace.visualstudio.com/manage/publishers/KDAB and upload the *.vsix file.

0 comments on commit baa4538

Please sign in to comment.