Skip to content

Commit

Permalink
Merge branch 'main' into pr-template
Browse files Browse the repository at this point in the history
  • Loading branch information
eddycharly authored Nov 6, 2024
2 parents 3f15b07 + 255749c commit c01bc73
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-config.json

blank_issues_enabled: true

contact_links:
- name: Discussions
url: https://github.com/kyverno/kyverno-envoy-plugin/discussions
about: Please ask and answer questions here.
- name: Documentation
url: https://kyverno.github.io/kyverno-envoy-plugin
about: Browse documentation here.
35 changes: 35 additions & 0 deletions docs/RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Release docs

This doc contains information for releasing a new version.

## Create a release

Creating a release can be done by pushing a tag to the GitHub repository (beginning with `v`).

The [release workflow](../../.github/workflows/release.yaml) will take care of creating the GitHub release and will publish artifacts.

```shell
VERSION="v0.0.1"
TAG=$VERSION

git tag $TAG -m "tag $TAG" -a
git push origin $TAG
```

## Publish documentation

Publishing the documentation for a release is decoupled from cutting a release.

To publish the documentation push a tag to the GitHub repository (beginning with `docs-v`).

```shell
VERSION="v0.0.1"
TAG=docs-$VERSION

git tag $TAG -m "tag $TAG" -a
git push origin $TAG
```

## Misc

- Add to the drop-down list in the bug template

0 comments on commit c01bc73

Please sign in to comment.