Merge pull request #11 from kubewarden/fix-artifacthub

feat: Publish to artifacthub via artifacthub branch

Author: flavio

.github/workflows/release.yml.template .github/workflows/release.yml.github/workflows/release.yml.template renamed to .github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
 
   test:
     name: run tests and linters
-    uses: kubewarden/github-actions/.github/workflows/reusable-test-policy-swift.yml@v2
+    uses: kubewarden/github-actions/.github/workflows/reusable-test-policy-swift.yml@v3.1.0
 
   release:
     needs: test
@@ -23,8 +23,6 @@ jobs:
       # Required by cosign keyless signing
       id-token: write
 
-    uses: kubewarden/github-actions/.github/workflows/reusable-release-policy-swift.yml@v2
+    uses: kubewarden/github-actions/.github/workflows/reusable-release-policy-swift.yml@v3.1.0
     with:
-      oci-target: # FIXME: use something like: ghcr.io/${{ github.repository_owner }}/policies/policy-name
-    secrets:
-      workflow-pat: ${{ secrets.WORKFLOW_PAT }}
+      oci-target: ghcr.io/${{ github.repository_owner }}/policies/policy-name # FIXME

.github/workflows/test.yml.template .github/workflows/test.yml.github/workflows/test.yml.template renamed to .github/workflows/test.yml

@@ -3,4 +3,4 @@ name: Continuous integration
 jobs:
   test:
     name: run tests and linters
-    uses: kubewarden/github-actions/.github/workflows/reusable-test-policy-swift.yml@v2
+    uses: kubewarden/github-actions/.github/workflows/reusable-test-policy-swift.yml@v3.1.0

Makefile

@@ -1,6 +1,8 @@
 CONTAINER_RUNTIME ?= docker
 CONTAINER_IMAGE := "ghcr.io/kubewarden/swift-wasm-runner:5.3-p1"
-VERSION := $(shell git describe --exact-match --tags $(git log -n1 --pretty='%h') | cut -c2-)
+# It's necessary to call cut because kwctl command does not handle version
+# starting with v.
+VERSION ?= $(shell git describe | cut -c2-)
 
 build:
 ifndef CONTAINER_RUNTIME
@@ -43,11 +45,14 @@ endif
 	wasm-opt -Os .build/wasm32-unknown-wasi/release/Policy.wasm -o policy.wasm
 
 artifacthub-pkg.yml: metadata.yml
+	$(warning If you are updating the artifacthub-pkg.yml file for a release, \
+	  remember to set the VERSION variable with the proper value. \
+	  To use the latest tag, use the following command:  \
+	  make VERSION=$$(git describe --tags --abbrev=0 | cut -c2-) annotated-policy.wasm)
 	kwctl scaffold artifacthub \
-	    --metadata-path metadata.yml --version $(VERSION) \
-		--questions-path questions-ui.yml > artifacthub-pkg.yml.tmp \
-	&& mv artifacthub-pkg.yml.tmp artifacthub-pkg.yml \
-	|| rm -f artifacthub-pkg.yml.tmp
+	  --metadata-path metadata.yml --version $(VERSION) \
+	  --output artifacthub-pkg.yml
+
 
 annotate: artifacthub-pkg.yml
 	kwctl annotate -m metadata.yml -u README.md -o annotated-policy.wasm policy.wasm

artifacthub-pkg.yml

@@ -1,36 +1,49 @@
----
-###
-### Use `make artifacthub-pkg.yml` to auto-generate this file
-### See docs.kubewarden.io for publishing to ArtifactHub
-###
-version: 0.0.1
+# Kubewarden Artifacthub Package config
+#
+# Use this config to submit the policy to https://artifacthub.io.
+#
+# This config can be saved to its default location with:
+#   kwctl scaffold artifacthub > artifacthub-pkg.yml 
+version: 0.0.1-unreleased-3-g7dcff17
 name: policy-name
 displayName: Policy Name
-createdAt: '2022-07-19T16:39:10+02:00'
-description: DESCRIPTION OF YOUR POLICY
+createdAt: 2023-03-24T17:39:26.902596213Z
+description: Short description
 license: Apache-2.0
-homeURL: POLICY HOMEPAGE URL
+homeURL: https://github.com/yourorg/policy-name
 containersImages:
 - name: policy
-  image: "<registry>/<policy-name>:0.0.1"
-install: |
-  The policy can be obtained using [`kwctl`](https://github.com/kubewarden/kwctl/):
-
-  ```console
-  kwctl pull <registry>/<policy-name>:0.0.1
-  ```
+  image: ghcr.io/yourorg/policies/policy-name:v0.0.1-unreleased-3-g7dcff17
 keywords:
-- this is freeform
+- pod
+- cool policy
+- kubewarden
 links:
 - name: policy
-  url: https://github.com/yourorg/policy-name/releases/download/0.0.1/policy.wasm
+  url: https://github.com/yourorg/policy-name/releases/download/v0.0.1-unreleased-3-g7dcff17/policy.wasm
 - name: source
-  url: POLICY HOMEPAGE URL
+  url: https://github.com/yourorg/policy-name
+install: |
+  The policy can be obtained using [`kwctl`](https://github.com/kubewarden/kwctl):
+  ```console
+  kwctl pull ghcr.io/yourorg/policies/policy-name:v0.0.1-unreleased-3-g7dcff17
+  ```
+maintainers:
+- name: Author name
+  email: author-email@example.com
 provider:
   name: kubewarden
 recommendations:
 - url: https://artifacthub.io/packages/helm/kubewarden/kubewarden-controller
 annotations:
-  kubewarden/resources: Pod # comma separated list
-  kubewarden/mutation: false
-  kubewarden/contextAware: false
+  kubewarden/mutation: 'false'
+  kubewarden/resources: Pod
+  kubewarden/rules: |
+    - apiGroups:
+      - ''
+      apiVersions:
+      - v1
+      resources:
+      - pods
+      operations:
+      - CREATE

metadata.yml

@@ -15,7 +15,7 @@ annotations:
   # kubewarden specific:
   io.kubewarden.policy.title: policy-name
   io.kubewarden.policy.description: Short description
-  io.kubewarden.policy.author: policy-author
+  io.kubewarden.policy.author: "Author name <author-email@example.com>"
   io.kubewarden.policy.url: https://github.com/yourorg/policy-name
   io.kubewarden.policy.source: https://github.com/yourorg/policy-name
   io.kubewarden.policy.license: Apache-2.0