Skip to content

Conversation

@Joibel
Copy link
Member

@Joibel Joibel commented Mar 7, 2025

Fixes kubernetes versions in documentation - this doesn't work as hoped from #14176

Motivation

Docs get rebuilt on every push to a branch, so RELEASE_TAG isn't usable

Modifications

Use the GIT_BRANCH variable and check we're on an appropriate branch

Verification

make docs

Documentation

Not needed

Signed-off-by: Alan Clucas <alan@clucas.org>
@Joibel Joibel requested a review from MasonM March 7, 2025 08:58
@Joibel Joibel added the area/docs Incorrect, missing, or mistakes in docs label Mar 7, 2025
@Joibel Joibel marked this pull request as ready for review March 7, 2025 08:59
Copy link
Member

@MasonM MasonM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

./hack/docs/check-env-doc.sh
# build the docs
ifeq ($(RELEASE_TAG),true)
ifeq ($(shell echo $(GIT_BRANCH) | head -c 8),release-)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually started off doing this, but went with the release tag approach because you mentioned concerns in #14176 (comment) that an update to the k8s version may have occurred on the branch without a release. I'm assuming that's rare enough this isn't a big problem.

I did start on a branch to fully automate this using the peter-evans/create-pull-request action, though I'm not sure it's worth it, and determining the branch name from the release tag turned out to be a bit more complicated than I expected:
main...MasonM:argo-workflows:automate-docs-update

@Joibel Joibel requested a review from isubasinghe March 10, 2025 14:48
@Joibel Joibel merged commit 1c8b33a into argoproj:main Mar 11, 2025
54 of 57 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Incorrect, missing, or mistakes in docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants