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

Plugin template: Update and add sample versions file #4783

Merged
merged 3 commits into from
Nov 16, 2022
Merged

Plugin template: Update and add sample versions file #4783

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2b77490
add sample versions file and update plugin template [skip ci]
lena-larionova Nov 15, 2022
922f8dd
uncomment version to prevent build from failing
lena-larionova Nov 16, 2022
7328b2d
Apply suggestions from code review
lena-larionova Nov 16, 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
16 changes: 6 additions & 10 deletions app/_hub/_init/my-extension/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,9 @@
# Your publisher path is relative to app/_hub/.
# The path must consist only of alphanumeric characters and hyphens (-).
#
# 2. Create a versions.yml file in your new plugin directory.
# 2. Duplicate the versions.yml file into your new plugin directory.
# Set the Kong Gateway version that the plugin is being added to.
# Use the following format in that file (see docs/single-sourced-plugins.md for more info):
#
# strategy: gateway
#
# releases: # Fill in the Gateway version that this plugin is being added in.
# - 3.0.x
#

# 3. Add a 64x64px icon for the plugin to app/_assets/images/icons/hub.
# The name of the file must be in the following format: <publisher>_<plugin-directory-name>.png
# For example, for the rate limiting plugin the icon name is kong-inc_rate-limiting.png
Expand Down Expand Up @@ -135,7 +129,8 @@ params: # Metadata about your plugin
# Affects generation of examples and config table.
protocols:
# List of protocols this plugin is compatible with, in array format.
# Valid values: "http", "https", "tcp", "tls"
# Valid values: "http", "https", "tcp", "tls", "tls-passthrough", "grpc",
# "grpcs", "udp", "ws", and "wss".
# Example:
# - name: http
# - name: https
Expand Down Expand Up @@ -215,7 +210,8 @@ examples, limitations, use cases, etc. -->

<!-- Add a changelog entry in the following format for every change to the plugin:

### Kong Gateway <version number>
**Kong Gateway <version number>**

* Added X parameter for doing XYZ.
* Removed the deprecated Z parameter.
-->
10 changes: 10 additions & 0 deletions app/_hub/_init/my-extension/versions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Duplicate this file into your own plugin doc directory under app/_hub/.
# If adding a Kong-owned plugin, add it to app/_hub/kong-inc/<plugin-name>.

strategy: gateway

releases:
# Array of Kong Gateway releases that this plugin is compatible with.
# If adding a new plugin for a specific release, only list that release.
# For example:
- 3.0.x