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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摉 Update CONTRIBUTING.md re golang version #2937

Merged
merged 2 commits into from
Apr 10, 2023

Conversation

fileppb
Copy link
Contributor

@fileppb fileppb commented Mar 30, 2023

fixes #2904

Does not improve the verify-go-versions.sh script which uses a hardcoded high level go version "1".

Summary

Related issue(s)

Fixes #

fixes bug of kcp-dev#2904 regarding go lang version in documentation. 

Does not improve the verify-go-versions.sh script which uses a hardcoded high level go version "1".
@ncdc ncdc changed the title Update CONTRIBUTING.md re golang version 馃摉 Update CONTRIBUTING.md re golang version Apr 4, 2023
Comment on lines 23 to 28
Please note that the go language version numbers in these files must exactly agree:
- Your local go/go.mod file, kcp/.ci-operator.yaml, kcp/Dockerfile, and in all the kcp/.github/workflows yaml files that specify go-version.
In kcp/.ci-operator.yaml the go version is indicated by the "tag" attribute.
In kcp/Dockerfile it is indicated by the "golang" attribute
In go.mod it is indicated by the "go" directive."
In the .github/workflows yaml files it is indicated by "go-version"
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for this! Could you please update the formatting so it renders better when the markdown is converted to html? See https://github.com/kcp-dev/kcp/blob/d5ad69188d61b6714f4181bd1119dba23a541aed/docs/content/CONTRIBUTING.md for example:

image

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 think I made the change. Let me know if there are still issues.

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 10, 2023
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Apr 10, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ncdc

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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 10, 2023
@openshift-merge-robot openshift-merge-robot merged commit 2202130 into kcp-dev:main Apr 10, 2023
6 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. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: Contributing.md description of prerequisites needs clarification regarding go version
3 participants