docs: add versioned docs - #378
Open
awphi wants to merge 6 commits into
Open
Conversation
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
muchzill4
reviewed
Jul 28, 2026
muchzill4
left a comment
Contributor
There was a problem hiding this comment.
We need to push latest major, not major.0.0. I.e.: 7.5.2 > 7.0.0.
|
|
||
| release_refs=$( | ||
| for ref in $(gh release list --exclude-drafts --exclude-pre-releases --limit 1000 --json tagName --jq '[.[] | select(.tagName | test("^v?[0-9]+\\.0\\.0$"))][:5][].tagName'); do | ||
| if git cat-file -e "$ref:docs/docs-config.json" 2>/dev/null; then |
Contributor
There was a problem hiding this comment.
has_docs_config_at_ref() {
git cat-file -e "$1:docs/docs-config.json" 2>/dev/null
}And maybe:
last_five_major_release_tags=$(
gh release list \
--exclude-drafts --exclude-pre-releases \
--limit 1000 --json tagName |
jq '[.[] | select(.tagName | test("^v?[0-9]+\\.0\\.0$"))][:5][].tagName'
)
Contributor
Author
There was a problem hiding this comment.
As discussed, have hard-coded a minimum major version to search from + made it fetch all latest releases from each major prefix
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
--include-headso we can preview a 'Latest' version in stagingAdds acompose.preview.yamlcompose project to preview the production/staging version of the docs locally. I don't foresee this being desperately useful but it does provide some level of confidence before deploying.I'm keen for feedback if we think the automated
versionsgeneration is the right way to go + if we need the local production preview project at all. Lmk!Checklist