Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
olblak authored May 15, 2024
1 parent 47d9578 commit d145df1
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,11 @@ The configuration file uses the YAML format and accepts the following parameters

### Changelogs

**name** defines the changelog name to monitor. It is used to identify a changelog configuration among differentts ones.

**dir** defines the directory where to mirror the release note

**kind** defines the kind of changelog to mirror, for example `github`

**formats** defines a list of format parameters for the mirrored changelog.

**spec** defines specific parameters to a kind of mirror.
- `name` defines the changelog name to monitor. It is used to identify a changelog configuration among differentts ones.
- `dir` defines the directory where to mirror the release note
- `kind` defines the kind of changelog to mirror, for example `github`
- `formats` defines a list of format parameters for the mirrored changelog.
- `spec` defines specific parameters to a kind of mirror.


The following example can be used for a HUGO website
Expand Down Expand Up @@ -89,9 +85,23 @@ The following environment variables will be used as a fallback

### Updatecli

Releasepost is designed to work with [Updatecli](https://github.com/updatecli/updatecli) where releasepost is responsible to generate the correct files based on third changelogs and Updatecli to automate the process of publishing them to a git repository
Releasepost is designed to work with [Updatecli](https://github.com/updatecli/updatecli) where releasepost is responsible to generate the correct files based on third changelogs and Updatecli to automate the process of publishing them to a git repository.

It can be used with one of the two Updatecli policy:

#### HUGO

Used by the Updatecli project to publish all release notes on [updatecli.io](https://www.updatecli.io/changelogs/updatecli/)

* [ghcr.io/updatecli/policies/releasepost/releasepost](https://github.com/updatecli/policies/tree/main/updatecli/policies/releasepost/releasepost)
* [releasepost.yaml](https://github.com/updatecli/website/blob/master/.releasepost.yaml)

#### Docusaurus - rancher.fleet.io

Used by the Rancher Fleet project to publish all releast note associated to a MAJOR.MINOR version - [rancher.fleet.io](https://fleet.rancher.io/0.9/changelogs/changelogs/v0.9.3)

TODO: Show an updatecli demo
* [ghcr.io/olblak/rancherlabs-policies/docusaurus/releasepost](https://github.com/olblak/rancherlabs-policies/tree/main/updatecli/policies/docusaurus/releasepost)
* [releasepost.yaml](https://github.com/rancher/fleet-docs/blob/main/releasepost.yaml)

## Contributing

Expand Down

0 comments on commit d145df1

Please sign in to comment.