Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Generate release notes from structured data #176

Open
maroshii opened this issue Aug 25, 2022 · 1 comment
Open

Generate release notes from structured data #176

maroshii opened this issue Aug 25, 2022 · 1 comment

Comments

@maroshii
Copy link
Contributor

To be able to automate the release notes, we need as a first step to render them in place from structured data (json, yaml, etc). This will allow us to more easily update them on a new release with whatever strategy we see fit moving forward.

We could first start with semi-automating a PR into this repo but then move into a more elaborate workflow where we generate the versioned docs automatically via a okteto/app new-release webhook event.

@maroshii
Copy link
Contributor Author

Schema proposed:

- version: "1.0.0"
  description: "First stable major release as **markdown**"
  notes: # sections can be anything
    breaking-changes:
      - "chart rename"
    bugfixes:
      - "ingress-nginx upgrade to [v4.2.1](https://github.com/kubernetes/ingress-nginx/issues/8745)"
      - "typos"
    improvements:
      - "soft limits"
      - "fix critical CVEs"
- version: "0.15.1"
...

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant