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

[Question] Docs say use semver but linter enforces a 'v' to be prefixed. #2191

Closed
rumstead opened this issue Apr 18, 2022 · 7 comments
Closed
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@rumstead
Copy link
Contributor

rumstead commented Apr 18, 2022

https://semver.org/#is-v123-a-semantic-version

https://github.com/kubernetes-sigs/krew/blob/eda76d9eb403f290d3f25b7b2930b51f170a1312/internal/installation/semver/version.go#L45

Why is 'v' forced to be present, while stating we should use semver versioning?

@ahmetb
Copy link
Member

ahmetb commented Apr 18, 2022

This is a bit of a bike shedding discussion. The ecosystem already broadly adopts the v prefix. We can remove there restriction in the future. I doubt we are tied to it.

@rumstead
Copy link
Contributor Author

I agree. At the minimum, it would be helpful to note in the docs that "v" is required.

The docs say "# 'version' is a valid semantic version string (see semver.org)" and then semver.org proceeds to say that "v" is not valid semantic versioning.

https://krew.sigs.k8s.io/docs/developer-guide/plugin-manifest/

@ahmetb
Copy link
Member

ahmetb commented Apr 18, 2022

Ack, feel free to send a patch editing the comment on the inline yaml.
/good-first-issue
/kind docs

@k8s-ci-robot
Copy link
Contributor

@ahmetb:
This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

Ack, feel free to send a patch editing the comment on the inline yaml.
/good-first-issue
/kind docs

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
Copy link
Contributor

@ahmetb: The label(s) kind/docs cannot be applied, because the repository doesn't have them.

In response to this:

Ack, feel free to send a patch editing the comment on the inline yaml.
/good-first-issue
/kind docs

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 good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Apr 18, 2022
@rumstead
Copy link
Contributor Author

@ahmetb done

@rumstead
Copy link
Contributor Author

kubernetes-sigs/krew#766

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Development

No branches or pull requests

3 participants