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

Makefile and other visual changes. #1522

Merged
merged 1 commit into from
Feb 9, 2024

Conversation

kishen-v
Copy link
Contributor

@kishen-v kishen-v commented Nov 30, 2023

What this PR does / why we need it:
Changes in this PR:

  1. make serve is now made available from the parent Makefile and can be executed from the repository root.
  2. README.md changes to fix the broken link of License, and other related badges, alignment of the images, etc.
  3. Version bump of mdbook from v0.4.5 to v0.4.35.
  4. Add make update-go to update golang version across multiple files.
  5. Add make verify-go-version to find if there are any recent release of Go that can be updated.
Kishens-MacBook-Pro: cluster-api-provider-ibmcloud : mdbook-target ᐅ  make update-go VERSION=1.21.4

-FROM --platform=${BUILDPLATFORM} golang:1.20.11 as toolchain
+FROM --platform=${BUILDPLATFORM} golang:1.21.4 as toolchain

-GO_VERSION ?= 1.20.11
+GO_VERSION ?= 1.21.4

-FROM golang:1.20.11 AS ccm-builder
+FROM golang:1.21.4 AS ccm-builder
  1. Update favicon image to show clusterapi logo, from the default mdbook logo.
Pasted Graphic 4

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1510

Special notes for your reviewer: This PR has multiple commits. Please let me know if it needs to be made into separate PRs.

/area provider/ibmcloud

Release note:

make serve is now made available from the parent Makefile and can be executed from the repository root.
README.md changes to fix the broken link of License, and other related badges, alignment of the images, etc.
Version bump of mdbook from v0.4.5 to v0.4.37.
Add make update-go to update golang version across Makefiles
Add make verify-go-version to find if inconsistencies exist across files with regards to go version in Make/Submakefiles.
Update favicon image to ClusterAPI logo.

@k8s-ci-robot k8s-ci-robot added the area/provider/ibmcloud Issues or PRs related to ibmcloud provider label Nov 30, 2023
Copy link

netlify bot commented Nov 30, 2023

Deploy Preview for kubernetes-sigs-cluster-api-ibmcloud ready!

Name Link
🔨 Latest commit 4417e60
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-cluster-api-ibmcloud/deploys/65c5d190058bee0008aea5ef
😎 Deploy Preview https://deploy-preview-1522--kubernetes-sigs-cluster-api-ibmcloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 30, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @kishen-v. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 30, 2023
@kishen-v
Copy link
Contributor Author

/cc @Amulyam24 @Prajyot-Parab.

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@Prajyot-Parab
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 4, 2023
versions.mk Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@Prajyot-Parab
Copy link
Contributor

What this PR does / why we need it: Changes in this PR:

  1. make serve is now made available from the parent Makefile and can be executed from the repository root.
  2. README.md changes to fix the broken link of License, and other related badges, alignment of the images, etc.
  3. Version bump of mdbook from v0.4.5 to v0.4.35.
  4. Add make update-go to update golang version across multiple files.
Kishens-MacBook-Pro: cluster-api-provider-ibmcloud : mdbook-target ᐅ  make update-go VERSION=1.21.4

-FROM --platform=${BUILDPLATFORM} golang:1.20.11 as toolchain
+FROM --platform=${BUILDPLATFORM} golang:1.21.4 as toolchain

-GO_VERSION ?= 1.20.11
+GO_VERSION ?= 1.21.4

-FROM golang:1.20.11 AS ccm-builder
+FROM golang:1.21.4 AS ccm-builder
  1. Update favicon image to show clusterapi logo, from the default mdbook logo.
Pasted Graphic 4 **Which issue(s) this PR fixes** _(optional, in `fixes #(, fixes #, ...)` format, will close the issue(s) when PR gets merged)_: Fixes #1510

Special notes for your reviewer: This PR has multiple commits. Please let me know if it needs to be made into separate PRs.

/area provider/ibmcloud

Release note:

NONE

@kishen-v Update Release note section.

@kishen-v kishen-v force-pushed the mdbook-target branch 3 times, most recently from 0911e84 to 5078660 Compare December 15, 2023 14:36
Makefile Show resolved Hide resolved
Makefile Outdated
IFS=' ' read -r current_minor current_patch <<< "$$current_minor_patch_version"; \
if [ $$current_minor -le $$available_minor ]; then \
if [ $$current_patch -lt $$available_patch ] || [ $$current_minor -lt $$available_minor ]; then \
echo "::warning ::Update GO_VERSION to $$available_version"; \
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kishen-v kishen-v force-pushed the mdbook-target branch 3 times, most recently from 1caf951 to 44b176a Compare January 21, 2024 12:50
@Prajyot-Parab
Copy link
Contributor

@kishen-v
Is this the expected behaviour?

prajyotparab@Prajyots-MacBook-Pro cluster-api-provider-ibmcloud % make verify-go-version
fatal: No names found, cannot describe anything.
::warning ::Update GO_VERSION to go1.20.13
go1.20.13 is available on go.dev, the version in Makefile is 1.20.12.
Consider bumping the version, run make update-go VERSION=go1.20.13 to update across all files.

Copy link
Contributor

@Karthik-K-N Karthik-K-N left a comment

Choose a reason for hiding this comment

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

/lgtm

@Prajyot-Parab Please take a look

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

@Prajyot-Parab, If it's this line fatal: No names found, cannot describe anything.
I see the same error on my machine. I shall look into it.

@Prajyot-Parab
Copy link
Contributor

@Prajyot-Parab, If it's this line fatal: No names found, cannot describe anything. I see the same error on my machine. I shall look into it.

Yes, please check.

Copy link
Contributor

@Prajyot-Parab Prajyot-Parab left a comment

Choose a reason for hiding this comment

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

/lgtm

@Karthik-K-N ptal

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

@Karthik-K-N Karthik-K-N left a comment

Choose a reason for hiding this comment

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

Thanks for the PR

/lgtm

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 7, 2024
@kishen-v
Copy link
Contributor Author

kishen-v commented Feb 7, 2024

Hi @Prajyot-Parab / @Karthik-K-N,

I have incorporated the discussed changes where:

  1. Do away with go version set in the Makefile.
  2. Retrieve the go-version from the Dockerfile in repository root.
  3. Update go-version across all Dockerfiles in the repository.

Here are the o/ps.

Updating versions across all dockerfiles.

Kishens-MacBook-Pro:  cluster-api-provider-ibmcloud : mdbook-target :  make update-go VERSION=1.20.12
Updated go version to 1.20.12 across Dockerfile hack/ccm/Dockerfile

Verify that Go versions are same across all Dockerfiles

Kishens-MacBook-Pro:  cluster-api-provider-ibmcloud : mdbook-target : make verify-go-version
Versions are uniform across Dockerfiles, the go-version used is 1.20.12

And if not...

Kishens-MacBook-Pro: cluster-api-provider-ibmcloud : mdbook-target  :  make verify-go-version
Versions are different across Dockerfiles, please use 'make update-go'

cc: @mkumatag.

Copy link
Member

@mkumatag mkumatag left a comment

Choose a reason for hiding this comment

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

I will let @Prajyot-Parab to add lgtm

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 8, 2024
@Prajyot-Parab
Copy link
Contributor

@kishen-v lets do it this way

  1. Refer https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/main/Makefile#L23-L24 ,lets use same approach here, we will pass the image itself as build-arg to our docker commands and that way no need to fetch any version from Dockerfiles.
  2. Lets have check in place to verify the version mentioned in Makefile and ccm dockerfile is same, If yes all good, If no just throw out warning saying version mismatch and suggest user to have consistency.
    Also you can refer this older commit (3e0af2a) lets switch to this in ccm Dockerfile (this will avoid triggering update via depenbot), you can also pass that image as arg via ccm Makefile and have comparison done on it rather than Dockerfile
  3. Lets not have any command in place to update the versions via make (drop that logic)

let me know incase of any queries.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 8, 2024
@Prajyot-Parab
Copy link
Contributor

@kishen-v squash everything into 1 commit. (rest lgtm)

@Prajyot-Parab
Copy link
Contributor

/hold

@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 Feb 9, 2024
Update mdbook version and add target to sub-Makefile

Update badges, align images

Add make command to update go version across files

Add verify-go-version target
Copy link
Contributor

@Prajyot-Parab Prajyot-Parab left a comment

Choose a reason for hiding this comment

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

/lgtm

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Karthik-K-N, kishen-v, mkumatag, Prajyot-Parab

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

@Prajyot-Parab
Copy link
Contributor

/unhold

@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 Feb 9, 2024
@k8s-ci-robot k8s-ci-robot merged commit ea18e5b into kubernetes-sigs:main Feb 9, 2024
14 checks passed
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. area/provider/ibmcloud Issues or PRs related to ibmcloud provider 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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Optimise golang version update across multiple files
5 participants