-
Notifications
You must be signed in to change notification settings - Fork 6.5k
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
Refactor check_galaxy + fix version #10729
Refactor check_galaxy + fix version #10729
Conversation
/hold |
HI @VannTen Thanks for the PR change :-) 💕 Suggestion 1. Suggestion 2. I guess the Suggestion 1 is simple and enough to use :-) |
Suggestion 1.
Because the most common mistake is forgetting to modify galaxy.xml, it just changes the `if [[ $KUBESPRAY_VERSION != "v${version_from_galaxy}" ]]` to `if [[ $KUBESPRAY_VERSION == "v${version_from_galaxy}" ]]` to avoid the mistake.
Suggestion 2.
Or it needs a complex script to generate the next version from the KUBESPRAY_VERSION (both Y and Z versions), and check the version_from_galaxy whether it is in the next versions.
I guess the Suggestion 1 is simple and enough to use :-)
You're right, I'll do that for now and leave a TODO. I'm just a bit confused by the fact we have KUBESPRAY_VERSION set to the previous major release. (But I guess it's to check upgrades).
|
Instead use a more generic documentation for installing kubespray as a collection from git.
This is only intented to check for human error. The version in galaxy should be the next (which does not mean the same if we're on master or a release branch).
cbcbd47
to
2641da3
Compare
/hold cancel |
@@ -15,7 +15,7 @@ Kubespray can be installed as an [Ansible collection](https://docs.ansible.com/a | |||
collections: | |||
- name: https://github.com/kubernetes-sigs/kubespray | |||
type: git | |||
version: v2.23.1 | |||
version: master # use the appropriate tag or branch for the version you need |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HI @VannTen
The docs files will auto-sync to the docs site: https://kubespray.io/#/docs/ansible_collection?id=usage
As a docs reader, he may follow the docs step by step.
Using a released version is better than a master branch, so the v2.23.1
may be fine for them.
Best Regards :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HI @VannTen
What do you think of the comments?
It is better to merge the PR before the release. :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rather avoid specifying a particular tag, because the user still needs to think of what version they need rather than going blindly through the step.
Besides, we already use placeholders in that doc (INVENTORY
and PLAYBOOK
in step 4).
IMO, we should either leave master
or replace it with BRANCH/GIT_REF
(or something of the sort)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@VannTen Thanks a lot.
It's a nice solution too :-)
/approve
/cc @MrFreezeex |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks 👍
/lgtm
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: MrFreezeex, VannTen, yankay The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
* Remove checks for docs using exact tags Instead use a more generic documentation for installing kubespray as a collection from git. * Check that we upgraded galaxy.yml to next version This is only intented to check for human error. The version in galaxy should be the next (which does not mean the same if we're on master or a release branch). * Set collection version to KUBESPRAY_NEXT_VERSION
* Remove checks for docs using exact tags Instead use a more generic documentation for installing kubespray as a collection from git. * Check that we upgraded galaxy.yml to next version This is only intented to check for human error. The version in galaxy should be the next (which does not mean the same if we're on master or a release branch). * Set collection version to KUBESPRAY_NEXT_VERSION
* Bump galaxy.yml to next expected version * Refactor check_galaxy + fix version (#10729) * Remove checks for docs using exact tags Instead use a more generic documentation for installing kubespray as a collection from git. * Check that we upgraded galaxy.yml to next version This is only intented to check for human error. The version in galaxy should be the next (which does not mean the same if we're on master or a release branch). * Set collection version to KUBESPRAY_NEXT_VERSION
* Remove checks for docs using exact tags Instead use a more generic documentation for installing kubespray as a collection from git. * Check that we upgraded galaxy.yml to next version This is only intented to check for human error. The version in galaxy should be the next (which does not mean the same if we're on master or a release branch). * Set collection version to KUBESPRAY_NEXT_VERSION
* Remove checks for docs using exact tags Instead use a more generic documentation for installing kubespray as a collection from git. * Check that we upgraded galaxy.yml to next version This is only intented to check for human error. The version in galaxy should be the next (which does not mean the same if we're on master or a release branch). * Set collection version to KUBESPRAY_NEXT_VERSION
* Remove checks for docs using exact tags Instead use a more generic documentation for installing kubespray as a collection from git. * Check that we upgraded galaxy.yml to next version This is only intented to check for human error. The version in galaxy should be the next (which does not mean the same if we're on master or a release branch). * Set collection version to KUBESPRAY_NEXT_VERSION
What type of PR is this?
What this PR does / why we need it:
Set galaxy.yml to 1.24.0
Remove checks for docs using exact tags
Instead use a more generic documentation for installing kubespray as a
collection from git.
Check KUBESPRAY_VERSION != galaxy.yml version
Special notes for your reviewer:
See #10664 and #10727
Does this PR introduce a user-facing change?: