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

Refactor check_galaxy + fix version #10729

Merged
merged 3 commits into from
Jan 11, 2024

Conversation

VannTen
Copy link
Contributor

@VannTen VannTen commented Dec 18, 2023

What type of PR is this?

/kind design

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?:

Refactor check_galaxy + fix version

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 18, 2023
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 18, 2023
@VannTen
Copy link
Contributor Author

VannTen commented Dec 18, 2023

/hold
Not sure how to handle that 🤔 ...

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 18, 2023
@yankay
Copy link
Member

yankay commented Dec 19, 2023

/hold Not sure how to handle that 🤔 ...

HI @VannTen

Thanks for the PR change :-) 💕

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 :-)

@VannTen
Copy link
Contributor Author

VannTen commented Dec 19, 2023 via email

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).
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 19, 2023
@VannTen
Copy link
Contributor Author

VannTen commented Dec 19, 2023

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 19, 2023
@@ -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
Copy link
Member

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 :-)

Copy link
Member

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. :-)

Copy link
Member

Choose a reason for hiding this comment

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

HI @VannTen

I create a PR for the comments, VannTen#1 .

Would you please help to review it :-)

Copy link
Contributor Author

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)

Copy link
Member

@yankay yankay Jan 11, 2024

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

@yankay yankay mentioned this pull request Dec 25, 2023
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 11, 2024
@VannTen
Copy link
Contributor Author

VannTen commented Jan 11, 2024

/cc @MrFreezeex
(for review)

Copy link
Member

@MrFreezeex MrFreezeex left a comment

Choose a reason for hiding this comment

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

Thanks 👍
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 11, 2024
@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit e90cae9 into kubernetes-sigs:master Jan 11, 2024
64 checks passed
VannTen added a commit to VannTen/kubespray that referenced this pull request Jan 11, 2024
* 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
VannTen added a commit to VannTen/kubespray that referenced this pull request Jan 11, 2024
* 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
k8s-ci-robot pushed a commit that referenced this pull request Jan 12, 2024
* 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
VannTen added a commit to VannTen/kubespray that referenced this pull request Feb 6, 2024
* 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
k8s-ci-robot pushed a commit that referenced this pull request Feb 6, 2024
* 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
pedro-peter pushed a commit to pedro-peter/kubespray that referenced this pull request May 8, 2024
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants