From d997d37c950ce112aca966962dce3e29d64ed0f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Wed, 6 Nov 2024 10:07:36 +0100 Subject: [PATCH 1/2] docs: add release docs (#170) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché --- docs/RELEASE.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/RELEASE.md diff --git a/docs/RELEASE.md b/docs/RELEASE.md new file mode 100644 index 0000000..12c0241 --- /dev/null +++ b/docs/RELEASE.md @@ -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 From 255749c6635f789f6dbf6ef0a5fe95b6e40d15e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Wed, 6 Nov 2024 10:07:50 +0100 Subject: [PATCH 2/2] chore: add issues config (#171) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché --- .github/ISSUE_TEMPLATE/config.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..faadcff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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.