Skip to content

Commit

Permalink
chore(docs): add notes on how releases are done (#13)
Browse files Browse the repository at this point in the history
* chore(docs): add notes on how releases are done
  • Loading branch information
bostrt committed Jun 30, 2022
1 parent a445758 commit a69a0c6
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/dev.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Provider Certification Tool

## Release

Releasing a new version of the provider certification tool is done automatically through [this GitHub Action](https://github.com/redhat-openshift-ecosystem/provider-certification-tool/blob/main/.github/workflows/release.yaml)
which is run on new tags. Tags should be named in format: v0.1.0.

Tags should only be created from the `main` branch which only accepts pull-requests that pass through [this CI GitHub Action](https://github.com/redhat-openshift-ecosystem/provider-certification-tool/blob/main/.github/workflows/go.yaml).

Note that any version in v0.* will be considered part of the preview release of the certification tool.

## Development Notes

This tool builds heavily on
Expand Down Expand Up @@ -76,4 +86,4 @@ vi /tmp/openshift-kube-conformance.yaml
3. Launch certification tool with customized plugin:
```
openshift-provider-cert run --plugin /tmp/openshift-kube-conformance.yaml --plugin /tmp/openshift-conformance-validated.yaml
```
```

0 comments on commit a69a0c6

Please sign in to comment.