Skip to content

Release docs with a regular release #2382

New issue

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

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

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

twobiers
Copy link

@twobiers twobiers commented May 20, 2025

Explanation

Currently docs for Chainsaw are released whenever a docs-v* tag is pushed. The last time this happens was with https://github.com/kyverno/chainsaw/releases/tag/docs-v0.2.3, nearly one year ago. Since then the newest features (e.g. StepTemplate) are only accessible in the "main" documentation.
This is not ideal, especially since the warning banner is telling reads to go to the """latest""" version v0.2.3
image

I suspect this is a process issue of the fact docs releases are decoupled from regular releases. Therefore this changes proposes to unify them.

Related issue

#2373

Proposed Changes

This PR proposes a unified release process of release artefacts and documentation. This requires less mental effort when doing releases and no checklist besides creating a simple tag.

Checklist

  • I have read the contributing guidelines.
  • I have read the PR documentation guide and followed the process including adding proof manifests to this PR.
  • This is a bug fix and I have added unit tests that prove my fix is effective.

Further Comments

Please treat this as a propsal, my goal here is to start a discussion as I as an external contributor won't handle releases myself.

@twobiers twobiers requested a review from a team as a code owner May 20, 2025 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant