Update README.md

This commit is contained in:
Alvaro Muñoz
2023-03-16 22:43:56 +01:00
committed by GitHub
parent a99cc6b08a
commit d5aad41447

View File

@@ -27,3 +27,26 @@ gh mrva download [--controller <CONTROLLER>] --lang <LANGUAGE> --output-dir <OUT
Note: `controller` is only optionals if defined in the configuration file
Note: if a `name` is provided, the run ID is not necessary and instead `gh-mrva` will download the artifacts associated that `name` as found in the configuration file
## Contributing
gh-mrva is a work in progress. If you have ideas for new fixes or improvements, please open an issue or pull request.
If possible, tests should be added for any new fixes. We favour testing with real file systems or processes where possible.
## Releasing
Releasing is currently done via tags. To release a new version, create a new tag and push it to the remote. The release workflow will automatically build and publish the new version.
e.g.
```sh
# Determine the latest tag
git tag -l | sort -V | tail -n 1
# Create a new tag
git tag -a v0.0.2 -m "Release v0.0.2"
# Push the tag to the remote
git push origin --tags
```