Skip to content

Commit 041db57

Browse files
authored
Update README.md
add usage instructions
1 parent 50a3851 commit 041db57

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,16 @@
22
Example repository for building and publishing a VCV Rack plugin with GitHub Actions.
33

44
![Build VCV Rack Plugin](https://github.com/qno/vcv-plugin-github-actions-example/workflows/Build%20VCV%20Rack%20Plugin/badge.svg)
5+
6+
___
7+
8+
### How to build a VCVRack plugin with Github Action
9+
10+
1. In your plugin repository create a folder `.github/workflows`
11+
2. Put the workflow definition [build-plugin.yml](https://github.com/qno/vcv-plugin-github-actions-example/blob/main/.github/workflows/build-plugin.yml) into this folder
12+
3. Make changes to your sources and push them to Github
13+
4. In your Github repository navigate into the Action tab to see the progress and status of the Workflow run
14+
5. To create a Github Release that contains the built plugin for all platforms you need to create and push a tag, e.g. like this:
15+
* `git tag v2.0.9 -m "create v2.0.9"`
16+
* `git push origin --tags`
17+
* **Note:** Make sure that your tag version number is the same as the version in the [plugin.json](https://github.com/qno/vcv-plugin-github-actions-example/blob/main/plugin.json#L4) and the tag starts with v (it is a convention), otherwise the the publish step will be canceled.

0 commit comments

Comments
 (0)