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.

Sign up for GitHub

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

Updating docs to include the need for a 'v' before the semver version. #766

Merged
merged 8 commits into from
Apr 19, 2022
Merged

Updating docs to include the need for a 'v' before the semver version. #766

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3ad064a
Updating docs for 'v' version
rumstead Apr 18, 2022
0eb14e0
Update submitting-to-krew.md
rumstead Apr 18, 2022
c70e8a9
Update plugin-updates.md
rumstead Apr 18, 2022
1eb5f8d
Update plugin-manifest.md
rumstead Apr 18, 2022
107db76
Update submitting-to-krew.md
rumstead Apr 19, 2022
18f61f0
Update submitting-to-krew.md
rumstead Apr 19, 2022
c67c5cf
Update plugin-updates.md
rumstead Apr 19, 2022
d58c7d4
Update submitting-to-krew.md
rumstead Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/content/docs/developer-guide/plugin-manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ metadata:
# the plugin is invoked, for example: `kubectl restart`
name: restart
spec:
# 'version' is a valid semantic version string (see semver.org)
# 'version' is a valid semantic version string (see semver.org). Note the prefix 'v' is required.
version: "v0.0.1"
# 'homepage' usually links to the GitHub repository of the plugin
homepage: https://github.com/achanda/kubectl-restart
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/developer-guide/release/plugin-updates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This manual operation looks like:

> **Note:** Ideally, the specified `version:` field should match the release tag
of the plugin. This helps users and maintainers to easily identify which
version of the plugin they have installed.
version of the plugin they have installed. Also, the prefix 'v' is required.
rumstead marked this conversation as resolved.
Show resolved Hide resolved

If you only change the `version`, `uri` and `sha256` fields of your plugin manifest,
your pull request will be automatically approved, tested, and merged ([see an
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/developer-guide/release/submitting-to-krew.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ existing plugins.
1. Make sure to extract the LICENSE file during the plugin installation.
1. Tag a git release with a [semantic
version](https://semver.org) (e.g. `v1.0.0`).
1. [Test your plugin installation locally]({{< ref "../installing-locally.md" >}}).
rumstead marked this conversation as resolved.
Show resolved Hide resolved
> **Note:** the 'v' is required and will be linted against
rumstead marked this conversation as resolved.
Show resolved Hide resolved

## Submitting a plugin to krew-index

Expand Down