Skip to content
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

chore: add publish-docs workflow #181

Merged
merged 2 commits into from
Aug 17, 2024
Merged

chore: add publish-docs workflow #181

merged 2 commits into from
Aug 17, 2024

Conversation

aleclarson
Copy link
Member

@aleclarson aleclarson commented Aug 17, 2024

Summary

This PR has a 3 goals:

  1. When a tag is pushed to radashi-org/radashi, publish a new version of the docs. One exception to this is when a beta version only contains patches that did not change anything in the docs/ folder.
  2. Host multiple versions of the docs: one for the current stable version, one for the most recent beta version, one for the most recent alpha version (backed by the next branch, so breaking changes only), and finally the last two major versions before the current one. Old versions of the docs are phased out automatically. Only stable versions are published to the root directory. Others must have the "release ID" (e.g. v12.2-beta) in the URL.
  3. Keep a versions.json file that includes all currently published versions of the docs, so we can provide a dropdown selector on the website.

@aleclarson aleclarson merged commit 6ef7141 into main Aug 17, 2024
6 checks passed
@aleclarson aleclarson deleted the chore/publish-docs branch August 17, 2024 20:51
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