-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Tim Ramlot <[email protected]>
- Loading branch information
Showing
1 changed file
with
36 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,36 @@ | ||
# cmctl | ||
<p align="center"> | ||
<img src="https://raw.githubusercontent.com/cert-manager/cert-manager/d53c0b9270f8cd90d908460d69502694e1838f5f/logo/logo-small.png" height="256" width="256" alt="cert-manager project logo" /> | ||
</p> | ||
|
||
# cmctl - The cert-manager Command Line Tool | ||
|
||
`cmctl` is a command line tool that can help you manage cert-manager and its resources inside your cluster. | ||
|
||
## Documentation | ||
|
||
The documentation for `cmctl` can be found on the [cert-manager website](https://cert-manager.io/docs/usage/cmctl/). | ||
|
||
## Versioning | ||
|
||
Before v2, `cmctl` was located in the cert-manager repository and versioned together with cert-manager. | ||
Starting from v2, `cmctl` is versioned seperately from cert-manager itself. | ||
|
||
## Release Process | ||
|
||
Create a Git tag with a tagname that has a `v` prefix and push it to GitHub. | ||
This will trigger the [release workflow]. | ||
|
||
1. Create and push a Git tag | ||
|
||
```sh | ||
export VERSION=v2.0.0-alpha.0 | ||
git tag --annotate --message="Release ${VERSION}" "${VERSION}" | ||
git push origin "${VERSION}" | ||
``` | ||
|
||
2. Wait for the [release workflow] to succeed. | ||
|
||
3. Visit the [releases page], edit the draft release, click "Generate release notes", and publish the release. | ||
|
||
[release workflow]: https://github.com/cert-manager/cmctl/actions/workflows/release.yaml | ||
[releases page]: https://github.com/cert-manager/cmctl/releases |