-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
Ensure all links in docs point to the latest stable release rather than master #8124
Comments
It does not mean anything. If we do support it as stable, it means operating known bad practice. Using master/latest is fine for development environments and I've just updated the installation guide because production set-up has several important steps. |
Personally I wouldn't agree. I think it has a negative impact on those that are trying to use the tool for the first time if they are hit by pre-release bugs and other things? Equally I think the deviation in the fact that Argo CD uses Stable release / semver tags for quick start envs whilst workflows uses master/ |
To your first point - it is a good hypothesis - but we’ve never had a user report a pre-release bug from using quick-start. Only edge case bugs tend to get through testing. The only problem we seem to have is if users think they have pinned a version, but are in fact using latest. Here are some thoughts:
|
I'm fixing an Argo deployment right now that was caused by this issue. We use GitOps for Argo workflows deployment. Even though we deploy from a specific tar.gz release, the deployment fails for older releases. The container with the latest image expects some CRDs which are missing from our current release. |
Summary
As a consequence of one of my PRs, a bug was introduced into the master branch of the Argo Workflows codebase. This had instant repercussions (see Github Issue here) for new users that were consuming the tool. Whenever the docs provide a link to manifests, they point to the master branch (see here), rather than the latest stable release branch.
The impacts of this are that new users get stalled while trying out the tool due to an unknown bug or change that is not reflected in the documentation, but also could lead to instances where (while it is certainly not best practice) users are running Argo Workflows manifests from
master
branch, which would mean they are using the:latest
tag on their images (see here for an example).What change needs making?
Change the docs to point exclusively to manifests at
https://raw.githubusercontent.com/argoproj/argo-workflows/stable/manifests/
rather thanhttps://raw.githubusercontent.com/argoproj/argo-workflows/master/manifests/
Note: From what I can see this is how the docs are maintained for Argo CD.
The text was updated successfully, but these errors were encountered: