carvel-dev / carvel-dev/release-scripts

Autogenerate documentation for new releases

Open
#22 0 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
Shell
Stars
4
Forks
4
PR merge metrics
No merged PRs in 30d

Description

**Describe the problem/challenge you have**
Right now the process to generate documentation for a new release is done manually following the steps in https://hackmd.io/uVpvITUuR4Cbwzkzb7MEpQ?view#Generate-new-docs-version
This process could be automatically triggered to create a new release when a new version is created.

**Describe the solution you'd like**
The idea would be similar to what we are doing with the update of the install script in the action https://github.com/vmware-tanzu/carvel-release-scripts/blob/main/.github/workflows/update-install-sh.yml

**Anything else you would like to add:**
Important things that we should take into account:
- When creating the docs it is important to know if this is a new version on top of the latest release version or a maintenance release since the script https://github.com/vmware-tanzu/carvel/blob/develop/site/hack/release-docs.sh needs that information to correctly produce the documentation
- This new automation needs to know the tool that is being released

---
Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help work on this issue.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.