Merge branch 'main' into cleanup

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

config/crds/envoy.kyverno.io_authorizationpolicies.yaml → .crds/envoy.kyverno.io_authorizationpolicies.yaml

@@ -17,6 +17,7 @@ spec:
   - name: v1alpha1
     schema:
       openAPIV3Schema:
+        description: AuthorizationPolicy defines an authorization policy resource
         properties:
           apiVersion:
             description: |-
@@ -36,11 +37,14 @@ spec:
           metadata:
             type: object
           spec:
+            description: AuthorizationPolicySpec defines the spec of an authorization
+              policy
             properties:
               authorizations:
                 description: Authorizations contain CEL expressions which is used
                   to apply the authorization.
                 items:
+                  description: Authorization defines an authorization policy rule
                   properties:
                     expression:
                       description: |-

.docs/RELEASE.md

@@ -0,0 +1,49 @@
+# 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 chart
+
+Publishing the chart for a release is decoupled from cutting a release.
+
+To publish the chart push a tag to the GitHub repository (beginning with `charts-v`).
+
+```shell
+VERSION="v0.0.1"
+TAG=charts-$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

.github/ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,68 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
+
+name: Bug Report
+description: Report a bug
+title: '[Bug] '
+labels:
+- bug
+- triage
+body:
+  - type: markdown
+    attributes:
+      value: Please tell us about the bug.
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: What version are you running?
+      options:
+      - v0.0.1
+    validations:
+      required: true
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Description
+      description: Describe what happened.
+    validations:
+      required: true
+  - type: textarea
+    id: bug-reproduce-steps
+    attributes:
+      label: Steps to reproduce
+      description: What are the exact steps needed to reproduce the bug you experienced?
+      value: |-
+        1. 
+    validations:
+      required: true
+  - type: textarea
+    id: bug-expectations
+    attributes:
+      label: Expected behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: bug-screenshots
+    attributes:
+      label: Screenshots
+      description: >-
+        If you have any screenshots that would help, please paste them below.
+        GitHub allows you to copy-and-paste directly from the clipboard into the text area.
+        **Please avoid taking screenshots of either log or terminal output**; paste any textual output in the logs section below.
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: Please copy and paste any relevant log output. 
+      render: Shell
+  - type: checkboxes
+    id: troubleshooting
+    attributes:
+      label: Troubleshooting
+      description: By submitting this issue, you agree that you have performed some basic attempts at researching and solving your problem.
+      options:
+        - label: I have searched other issues in this repository and mine is not recorded.
+          required: true

.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.

.github/ISSUE_TEMPLATE/feature-request.yaml

@@ -0,0 +1,52 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
+
+name: Feature Request
+description: Suggest a new feature
+title: '[Feature] '
+labels:
+- enhancement
+- triage
+body:
+  - type: markdown
+    attributes:
+      value: Please explain the new feature.
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem Statement
+      description: Describe the problem.
+      placeholder: A clear and concise description of the problem statement.
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Solution Description
+      description: Describe the solution you'd like.
+      placeholder: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: Describe alternatives you've considered.
+      placeholder: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Any additional context to this enhancement request.
+      placeholder: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
+  - type: checkboxes
+    id: research
+    attributes:
+      label: Research
+      description: By submitting this issue, you agree that you have performed some basic attempts at researching your problem and solution.
+      options:
+        - label: I have searched other issues in this repository and mine is not recorded.
+          required: true

.github/ISSUE_TEMPLATE/general-question.yaml

@@ -0,0 +1,36 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
+
+name: General Question
+description: Ask a question or need support
+title: '[Question] ' 
+labels:
+- question
+body:
+  - type: markdown
+    attributes:
+      value: Please answer these questions before submitting your issue. Thanks!
+  - type: textarea
+    id: describe-your-question
+    attributes:
+      label: Describe your question
+      description: Provide details about your question or the support needed.
+      placeholder: Type your question here...
+    validations:
+      required: true
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: What version are you running?
+      options:
+      - v0.0.1
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the question here.
+      placeholder: Additional details...
+    validations:
+      required: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,43 @@
+## Explanation
+
+<!--
+In a couple sentences, explain why this PR is needed and what it addresses. This should be an explanation a non-developer user can understand and covers the "why" question. It should also clearly indicate whether this PR represents an addition, a change, or a fix of existing behavior. This explanation will be used to assist in the release note drafting process.
+
+THIS IS MANDATORY.
+-->
+
+## Related issue
+
+<!--
+Please link the GitHub issue this pull request resolves in the format of `Fixes #1234`. If you discussed this change
+with a maintainer, please mention her/him using the `@` syntax (e.g. `@eddycharly`).
+
+If this change neither resolves an existing issue nor has sign-off from one of the maintainers, there is a
+chance substantial changes will be requested or that the changes will be rejected.
+-->
+
+## Proposed Changes
+
+<!--
+Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. 
+
+**nNOTE***: If this PR results in new or altered behavior which is user facing, you **MUST** read and follow the steps outlined in the [PR documentation guide](pr_documentation.md) and add Proof Manifests as defined below.
+-->
+
+## Checklist
+
+<!--
+Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of
+them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
+-->
+
+- [ ] I have read the [contributing guidelines](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md).
+- [ ] I have read the [PR documentation guide](https://github.com/kyverno/kyverno/blob/main/.github/pr_documentation.md) and followed the process including adding proof manifests to this PR.
+- [ ] This is a bug fix and I have added unit tests that prove my fix is effective.
+
+## Further Comments
+
+<!--
+If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution
+you did and what alternatives you considered, etc...
+-->

.github/workflows/codegen.yaml

@@ -0,0 +1,30 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+
+name: Verify codegen
+
+permissions: {}
+
+on:
+  pull_request:
+    branches:
+      - 'main'
+      - 'release*'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  verify-codegen:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
+        with:
+          go-version-file: go.mod
+          cache-dependency-path: go.sum
+      - name: Verify codegen
+        run: |
+          set -e
+          make verify-codegen

.github/workflows/helm-release.yaml

@@ -0,0 +1,39 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+
+name: Helm Release
+
+permissions: {}
+
+on:
+  push:
+    tags:
+      - 'charts-v*'
+
+jobs:
+  charts-releaser:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0
+      - name: Install Helm
+        uses: azure/setup-helm@fe7b79cd5ee1e45176fcad797de68ecaf3ca4814 # v4.2.0
+      - name: Set version
+        run: |
+          set -e
+          TAG=${{ github.ref_name }}
+          echo "CHART_VERSION=${TAG#charts-}" >> $GITHUB_ENV
+          VERSION=$(git describe --tags --match "v*" --abbrev=0)
+          echo "APP_VERSION=$VERSION" >> $GITHUB_ENV
+      - name: Run charts releaser
+        uses: stefanprodan/helm-gh-pages@0ad2bb377311d61ac04ad9eb6f252fb68e207260 #v1.7.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          linting: off
+          charts_dir: charts
+          app_version: ${{ env.APP_VERSION }}
+          chart_version: ${{ env.CHART_VERSION }}

.github/workflows/release.yaml

@@ -53,7 +53,7 @@ jobs:
         uses: ko-build/setup-ko@3aebd0597dc1e9d1a26bcfdb7cbeb19c131d3037 # v0.7
       - name: Run goreleaser
         id: goreleaser
-        uses: goreleaser/goreleaser-action@286f3b13b1b49da4ac219696163fb8c1c93e1200 # v6.0.0
+        uses: goreleaser/goreleaser-action@9ed2f89a662bf1735a48bc8557fd212fa902bebf # v6.1.0
         with:
           distribution: goreleaser
           version: latest

.gitignore

@@ -1,5 +1,8 @@
-.certs/
-.tools/
-website/site/
-/kyverno-envoy-plugin
+/.cache/
+/.certs/
+/.temp/
+/.tools/
+/.venv/
 /charts/*/charts
+/kyverno-envoy-plugin
+/website/site/