Docs latest release

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -36,7 +36,7 @@ body:
       <summary>Code & details examples</summary>
 
       `````markdown
-      Some code code written in Go:
+      Some code written in Go:
 
       ```go
       type Manager struct {

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -36,7 +36,7 @@ body:
       <summary>Code & details examples</summary>
 
       `````markdown
-      Some code code written in Go:
+      Some code written in Go:
 
       ```go
       type Manager struct {
@@ -75,7 +75,7 @@ body:
 
       Does it require a particular Kubernetes version?
 
-      Is there currently another isssue associated with this (use github syntax
+      Is there currently another issue associated with this (use github syntax
       like `#xyz` to link to it)?
   validations: {required: true}
 

.github/dependabot.yml

@@ -0,0 +1,49 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    # Workflow files stored in the
+    # default location of `.github/workflows`
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: ":seedling:"
+    labels:
+      - "ok-to-test"
+
+  # Maintain dependencies for go
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "ok-to-test"
+
+  # Maintain dependencies for dockerfile in the branches
+  - package-ecosystem: docker
+    directory: "/build/thirdparty/darwin"
+    target-branch: "tools-releases"
+    schedule:
+      interval: daily
+  - package-ecosystem: docker
+    directory: "/build/thirdparty/linux"
+    target-branch: "tools-releases"
+    schedule:
+      interval: "weekly"
+
+  # Maintain dependencies for dockerfile scaffold in the projects
+  - package-ecosystem: docker
+    directory: "testdata/project-v3"
+    schedule:
+      interval: daily
+  - package-ecosystem: docker
+    directory: "testdata/project-v4"
+    schedule:
+      interval: "weekly"

.github/workflows/apidiff.yml

@@ -6,40 +6,22 @@ on:
   pull_request:
 
 jobs:
-  check_docs_only:
-    name: check_docs_only
-    runs-on: ubuntu-18.04
-    outputs:
-      skip: ${{ steps.check_docs_only.outputs.skip }}
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - id: check_docs_only
-        # Since PR's are squashed prior to merging to the branch checked out (default branch),
-        # HEAD^ will resolve to the previous point in history.
-        run: |
-          REF="HEAD^"
-          [[ -z "${{ github.base_ref }}" ]] || REF=$(git show-ref ${{ github.base_ref }} | head -1 | cut -d' ' -f2)
-          echo "::set-output name=skip::$(test/check-docs-only.sh $REF)"
-
   go-apidiff:
     name: Verify API differences
     runs-on: ubuntu-latest
-    needs: check_docs_only
     # Pull requests from different repository only trigger this checks
-    if: (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository) && needs.check_docs_only.outputs.skip != 'true'
+    if: (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository)
     steps:
       - name: Clone the code
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: "1.19"
       - name: Execute go-apidiff
-        uses: joelanford/go-apidiff@v0.4.0
+        uses: joelanford/go-apidiff@v0.6.0
         with:
           compare-imports: true
           print-compatible: true

.github/workflows/lint.yml

@@ -6,40 +6,22 @@ on:
   pull_request:
 
 jobs:
-  check_docs_only:
-    name: check_docs_only
-    runs-on: ubuntu-18.04
-    outputs:
-      skip: ${{ steps.check_docs_only.outputs.skip }}
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - id: check_docs_only
-        # Since PR's are squashed prior to merging to the branch checked out (default branch),
-        # HEAD^ will resolve to the previous point in history.
-        run: |
-          REF="HEAD^"
-          [[ -z "${{ github.base_ref }}" ]] || REF=$(git show-ref ${{ github.base_ref }} | head -1 | cut -d' ' -f2)
-          echo "::set-output name=skip::$(test/check-docs-only.sh $REF)"
-
   lint:
     name: golangci-lint
     runs-on: ubuntu-latest
-    needs: check_docs_only
     # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
-    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && needs.check_docs_only.outputs.skip != 'true'
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
     steps:
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: 1.19
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Run linter
         uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.49 # Always uses the latest patch version.
+          version: v1.51
           only-new-issues: true # Show only new issues if it's a pull request
       - name: Report failure
         uses: nashmaniac/create-issue-action@v1.1
@@ -50,3 +32,10 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           labels: kind/bug
           body: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
+
+  yamllint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run yamllint make target
+        run: make yamllint

.github/workflows/release.yml

@@ -9,17 +9,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Fetch all tags
         run: git fetch --force --tags
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
           go-version: '~1.19'
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v2
+        uses: goreleaser/goreleaser-action@v4
         with:
           version: v1.11.2
           args: release -f ./build/.goreleaser.yml --rm-dist

.github/workflows/testdata.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: '1.19'
       - name: Remove pre-installed kustomize
@@ -25,6 +25,8 @@ jobs:
         run: sudo rm -f /usr/local/bin/kustomize
       - name: Verify testdata directory
         run: make check-testdata
+      - name: Verify docs update
+        run: make check-docs
       - name: Report failure
         uses: nashmaniac/create-issue-action@v1.1
         # Only report failures of pushes (PRs have are visible through the Checks section) to the default branch

.github/workflows/unit-tests-legacy.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           # the go/v2 cannot be updated and is scaffold with golang 1.13
           # (version used by its dep version of the controller-runtime)
@@ -32,7 +32,7 @@ jobs:
           # Therefore, we probably will deprecate go/v2 soon since we cannot upgrade it
           # to use the versions of controller-runtime > v0.9
           # and controller-tools > v0.6 as k8s > 1.21 then it might not be valid we spend effort on this fix
-          go-version: "1.17"
+          go-version: "1.19"
       # This step is needed as the following one tries to remove
       # kustomize for each test but has no permission to do so
       - name: Remove pre-installed kustomize

.github/workflows/unit-tests.yml

@@ -6,23 +6,6 @@ on:
   pull_request:
 
 jobs:
-  check_docs_only:
-    name: check_docs_only
-    runs-on: ubuntu-18.04
-    outputs:
-      skip: ${{ steps.check_docs_only.outputs.skip }}
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - id: check_docs_only
-        # Since PR's are squashed prior to merging to the branch checked out (default branch),
-        # HEAD^ will resolve to the previous point in history.
-        run: |
-          REF="HEAD^"
-          [[ -z "${{ github.base_ref }}" ]] || REF=$(git show-ref ${{ github.base_ref }} | head -1 | cut -d' ' -f2)
-          echo "::set-output name=skip::$(test/check-docs-only.sh $REF)"
-
   test:
     name: ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
@@ -31,14 +14,13 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-    needs: check_docs_only
     # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
-    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && needs.check_docs_only.outputs.skip != 'true'
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
     steps:
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: "1.19"
       # This step is needed as the following one tries to remove
@@ -61,15 +43,14 @@ jobs:
     name: Code coverage
     needs:
       - test
-      - check_docs_only
     runs-on: ubuntu-latest
     # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
-    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && needs.check_docs_only.outputs.skip != 'true'
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
     steps:
       - name: Clone the code
         uses: actions/checkout@v3
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
           go-version: "1.19"
       - name: Generate the coverage output

.github/workflows/verify.yml

@@ -13,6 +13,6 @@ jobs:
     steps:
     - name: Verifier action
       id: verifier
-      uses: kubernetes-sigs/kubebuilder-release-tools@v0.2.0
+      uses: kubernetes-sigs/kubebuilder-release-tools@v0.3.0
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,9 +1,12 @@
 .idea/
 .vscode/
-
+WORKSPACE
 # don't check in the build output of the book
 docs/book/book/
 
+# ignore auto-generated dir by `mdbook serve`
+docs/book/src/docs
+
 # Editor temp files
 *~
 \#*#
@@ -22,3 +25,4 @@ docs/book/book/
 # skip testdata go.sum, since it may have
 # different result depending on go version
 /testdata/**/go.sum
+/docs/book/src/simple-external-plugin-tutorial/testdata/sampleexternalplugin/v1/bin

.golangci.yml

@@ -1,3 +1,7 @@
+run:
+  deadline: 5m
+  allow-parallel-runners: true
+
 issues:
   # don't skip warning about doc comments
   # don't exclude the default set of lint
@@ -13,8 +17,41 @@ linters-settings:
     enable=fieldalignment: true
   revive:
     rules:
-    - name: if-return
-      disabled: true
+      # The following rules are recommended https://github.com/mgechev/revive#recommended-configuration
+      - name: blank-imports
+      - name: context-as-argument
+      - name: context-keys-type
+      - name: dot-imports
+      - name: error-return
+      - name: error-strings
+      - name: error-naming
+      - name: exported
+        disabled: true  # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
+      - name: if-return
+        disabled: true  # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
+      - name: increment-decrement
+      - name: var-naming
+        disabled: true   # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
+      - name: var-declaration
+      - name: package-comments
+        disabled: true  # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
+      - name: range
+      - name: receiver-naming
+      - name: time-naming
+      - name: unexported-return
+      - name: indent-error-flow
+      - name: errorf
+      - name: empty-block
+        disabled: true  # TODO: Investigate if it should be enabled. Disabled for now due to many findings.
+      - name: superfluous-else
+      - name: unused-parameter
+      - name: unreachable-code
+      - name: redefines-builtin-id
+      #
+      # Rules in addition to the recommended configuration above.
+      #
+      - name: bool-literal-in-expr
+      - name: constant-logical-expr
 
 linters:
   disable-all: true
@@ -40,6 +77,3 @@ linters:
     - unconvert
     - unparam
     - unused
-
-run:
-  deadline: 5m