Merge branch 'kubernetes-sigs:master' into geoproximity

Author: prasadkatti

.github/ISSUE_TEMPLATE/create-release.md

@@ -0,0 +1,24 @@
+---
+name: Create Release
+about: Release template to track the next release
+title: Release x.y
+labels: area/release
+assignees: ''
+
+---
+
+This Issue tracks the next `external-dns` release. Please follow the guideline below. If anything is missing or unclear, please add a comment to this issue so this can be improved after the release.
+
+#### Preparation Tasks
+
+- [ ] Release [steps](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/release.md#steps)
+
+#### Release Execution
+
+- [ ] Branch out from the default branch and run scripts/version-updater.sh to update the image tag used in the kustomization.yaml and in documentation.
+- [ ] Create the PR with this version change.
+- [ ] Create an issue to release the corresponding Helm chart via the chart release process (below) assigned to a chart maintainer
+
+#### After Release Tasks
+
+- [ ] Announce release on `#external-dns` in Slack

.github/pull_request_template.md

@@ -1,16 +1,18 @@
-<!--
-    Please read https://github.com/kubernetes-sigs/external-dns#contributing before submitting
-    your pull request. Please fill in each section below to help us better prioritize your pull request. Thanks!
--->
+## What does it do ?
+
+<!-- A brief description of the change being made with this pull request. -->
 
-**Description**
+## Motivation
 
-<!-- Please provide a summary of the change here. -->
+<!-- What inspired you to submit this pull request? -->
 
-<!-- Please link to all GitHub issue that this pull request implements(i.e. Fixes #123) -->
-Fixes #ISSUE
+## More
 
-**Checklist**
+- [ ] Yes, this PR title follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+- [ ] Yes, I added unit tests
+- [ ] Yes, I updated end user documentation accordingly
 
-- [ ] Unit tests updated
-- [ ] End user documentation updated
+<!--
+    Please read https://github.com/kubernetes-sigs/external-dns#contributing before submitting
+    your pull request. Please fill in each section below to help us better prioritize your pull request. Thanks!
+-->

.github/workflows/ci.yaml

@@ -17,7 +17,11 @@ jobs:
       checks: write  #  to create a new check based on the results (shogo82148/actions-goveralls)
 
     name: Build
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        # tests for target OS
+        os: [ubuntu-latest, macos-latest]
     steps:
 
     - name: Check out code into the Go module directory
@@ -38,7 +42,7 @@ jobs:
       run: |
             apt update
             apt install -y make gcc libc-dev git
-      if: github.actor == 'nektos/act'
+      if: github.actor == 'nektos/act' && matrix.os == 'ubuntu-latest'
 
     - name: Test
       run: make test
@@ -47,5 +51,5 @@ jobs:
       uses: shogo82148/actions-goveralls@v1
       with:
         path-to-profile: profile.cov
-      if: github.actor != 'nektos/act'
+      if: github.actor != 'nektos/act' && matrix.os == 'ubuntu-latest'
       continue-on-error: true

.github/workflows/dependency-update.yaml

@@ -17,7 +17,7 @@ jobs:
         uses: actions/[email protected]
       # https://github.com/renovatebot/github-action
       - name: self-hosted renovate
-        uses: renovatebot/github-action@v41.0.20
+        uses: renovatebot/github-action@v42.0.4
         with:
           # https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs.yaml

@@ -4,6 +4,9 @@ on:
   push:
     tags:
       - "v*"
+  # See https://docs.github.com/fr/webhooks/webhook-events-and-payloads#workflow_dispatch
+  # Can be used to update doc with latest tag
+  workflow_dispatch:
 
 permissions: {}
 
@@ -19,7 +22,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
           python-version: "3.12"
           cache: "pip"
@@ -35,5 +38,9 @@ jobs:
 
       - name: build and push
         run: |
-          mike deploy ${{ github.ref_name }} latest --push --update-aliases
+          VERSION="${{ github.ref_name }}"
+          if [[ ${{ github.event_name }} == "workflow_dispatch" ]]; then
+            VERSION="latest"
+          fi
+          mike deploy $VERSION --push --update-aliases
           mike set-default --push latest

.github/workflows/json-yaml-validate.yml

@@ -17,7 +17,9 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: json-yaml-validate
-        uses: GrantBirki/json-yaml-validate@v3.3.0
+        uses: GrantBirki/json-yaml-validate@v3.2.1 # pin @v3.2.1 bug in 3.3.0: https://github.com/GrantBirki/json-yaml-validate/issues/86
         with:
+          # ref: https://github.com/GrantBirki/json-yaml-validate?tab=readme-ov-file#inputs-
           comment: "true" # enable comment mode
           yaml_exclude_regex: "(charts/external-dns/templates.*|mkdocs.yml)"
+          allow_multiple_documents: "true"

.github/workflows/lint-test-chart.yaml

@@ -38,7 +38,7 @@ jobs:
           fi
 
       - name: Install Helm Docs
-        uses: action-stars/install-tool-from-github-release@ece2623611b240002e0dd73a0d685505733122f6 # v0.2.4
+        uses: action-stars/install-tool-from-github-release@f2e83e089fa618aa7e9fd3452fbcf4fe1598ede2 # v0.2.5
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           owner: norwoodj
@@ -65,7 +65,7 @@ jobs:
           helm unittest -f 'tests/*_test.yaml' --color charts/external-dns
 
       - name: Install Artifact Hub CLI
-        uses: action-stars/install-tool-from-github-release@ece2623611b240002e0dd73a0d685505733122f6 # v0.2.4
+        uses: action-stars/install-tool-from-github-release@f2e83e089fa618aa7e9fd3452fbcf4fe1598ede2 # v0.2.5
         with:
           github_token: ${{ github.token }}
           owner: artifacthub
@@ -78,7 +78,7 @@ jobs:
         run: ah lint --kind helm || exit 1
 
       - name: Install Python
-        uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
           token: ${{ github.token }}
           python-version: "3.x"

.github/workflows/lint.yaml

@@ -26,7 +26,7 @@ jobs:
         files: '.'
         config_file: ".markdownlint.json"
 
-    - name: Set up Go 1.x
+    - name: Set up Go
       uses: actions/setup-go@v5
       with:
         go-version-file: go.mod
@@ -44,14 +44,19 @@ jobs:
 
     # https://github.com/golangci/golangci-lint-action?tab=readme-ov-file#verify
     - name: Verify linter configuration and Lint go code
-      uses: golangci/golangci-lint-action@v7
+      uses: golangci/golangci-lint-action@v8
       with:
         verify: true
         args: --timeout=30m
-        version: v2.0
+        version: v2.1
 
       # Run Spectral
     - name: Lint OpenAPI spec
       uses: stoplightio/spectral-action@2ad0b9302e32a77c1caccf474a9b2191a8060d83 # v0.8.11
       with:
         file_glob: 'api/*.yaml'
+
+    - uses: actions/setup-python@v5
+    # https://github.com/pre-commit/action
+    - name: Verify with pre-commit
+      uses: pre-commit/[email protected]

.golangci.yml

@@ -3,20 +3,32 @@ version: "2"
 linters:
   default: none
   enable: # golangci-lint help linters
-    - dogsled
+    - copyloopvar # A linter detects places where loop variables are copied. https://golangci-lint.run/usage/linters/#copyloopvar
+    - dogsled # Checks assignments with too many blank identifiers. https://golangci-lint.run/usage/linters/#dogsled
+    - dupword # Duplicate word. https://golangci-lint.run/usage/linters/#dupword
     - goprintffuncname
     - govet
     - ineffassign
     - misspell
     - revive
-    - rowserrcheck
+    - rowserrcheck # Checks whether Rows.Err of rows is checked successfully.
+    - errchkjson # Checks types passed to the json encoding functions. ref: https://golangci-lint.run/usage/linters/#errchkjson
+    - errorlint # Checking for unchecked errors in Go code https://golangci-lint.run/usage/linters/#errcheck
     - staticcheck
     - unconvert
     - unused
+    - usestdlibvars # A linter that detect the possibility to use variables/constants from the Go standard library. https://golangci-lint.run/usage/linters/#usestdlibvars
     - whitespace
+    - decorder # Check declaration order and count of types, constants, variables and functions. https://golangci-lint.run/usage/linters/#decorder
+    - tagalign # Check that struct tags are well aligned. https://golangci-lint.run/usage/linters/#tagalign
     - predeclared # Find code that shadows one of Go's predeclared identifiers
     - sloglint # Ensure consistent code style when using log/slog
     - asciicheck  # Checks that all code identifiers does not have non-ASCII symbols in the name
+    - nilnil # Checks that there is no simultaneous return of nil error and an nil value. ref: https://golangci-lint.run/usage/linters/#nilnil
+    - cyclop # Checks function and package cyclomatic complexity. https://golangci-lint.run/usage/linters/#cyclop
+
+    # tests
+    - testifylint # Checks usage of github.com/stretchr/testify. https://golangci-lint.run/usage/linters/#testifylint
   settings:
     exhaustive:
       default-signifies-exhaustive: false
@@ -26,6 +38,19 @@ linters:
       rules:
         - name: confusing-naming
           disabled: true
+    cyclop: # Lower cyclomatic complexity threshold after the max complexity is lowered
+      max-complexity: 52
+    testifylint:
+      # Enable all checkers (https://github.com/Antonboom/testifylint#checkers).
+      # Default: false
+      enable-all: true
+      # Disable checkers by name
+      # (in addition to default
+      #   suite-thelper
+      # ).
+      # TODO: enable in follow-up
+      disable:
+        - require-error
   exclusions:
     generated: lax
     presets:
@@ -51,6 +76,10 @@ linters:
           - varcheck
           - whitespace
         path: _test\.go
+      # TODO: skiip as will require design changes
+      - linters:
+          - nilnil
+        path: istio_virtualservice.go|fqdn.go|cloudflare.go
     paths:
       - endpoint/zz_generated.deepcopy.go
       - third_party$
@@ -67,7 +96,6 @@ formatters:
   exclusions:
     generated: lax
     paths:
-      - endpoint/zz_generated.deepcopy.go
       - third_party$
       - builtin$
       - examples$

CONTRIBUTING.md

@@ -12,6 +12,25 @@ We have full documentation on how to get started contributing here:
 - [Kubernetes Contributor Guide](https://git.k8s.io/community/contributors/guide) - Main contributor documentation, or you can just jump directly to the [contributing section](https://git.k8s.io/community/contributors/guide#contributing)
 - [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet) - Common resources for existing developers
 
+This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification on PR title. The explicit commit history is used, among other things, to provide a readable changelog in release notes.
+
+## How to test a PR
+
+On Linux (or WSL), a PR can be tested following this instruction with [gh](https://cli.github.com/) and [golang](https://go.dev/):
+
+```bash
+gh repo clone kubernetes-sigs/external-dns
+cd external-dns
+gh pr checkout XXX # <=== Set PR number here
+go run main.go \
+  --kubeconfig=<kubeconfig_path> \
+  --log-format=text \
+  --log-level=debug \
+  --interval=1m
+  --provider=xxx
+  --source=yyy
+```
+
 ## Mentorship
 
 - [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers!

Makefile

@@ -32,10 +32,6 @@ else
 CONTROLLER_GEN=$(shell which controller-gen)
 endif
 
-#? controller-gen-install: download controller-gen if necessary
-controller-gen-install:
-	@scripts/install-tools.sh --generator
-
 #? golangci-lint-install: Install golangci-lint tool
 golangci-lint-install:
 	@scripts/install-tools.sh --golangci
@@ -67,10 +63,12 @@ oas-lint:
 .PHONY: lint
 lint: licensecheck go-lint oas-lint
 
-#? crd: Generates CRD using controller-gen
+#? crd: Generates CRD using controller-gen and copy it into chart
 .PHONY: crd
 crd: controller-gen-install
-	${CONTROLLER_GEN} crd:crdVersions=v1 paths="./endpoint/..." output:crd:stdout > docs/contributing/crd-source/crd-manifest.yaml
+	${CONTROLLER_GEN} object crd:crdVersions=v1 paths="./endpoint/..."
+	${CONTROLLER_GEN} object crd:crdVersions=v1 paths="./apis/..." output:crd:stdout > config/crd/standard/dnsendpoint.yaml
+	cp -f config/crd/standard/dnsendpoint.yaml charts/external-dns/crds/dnsendpoint.yaml
 
 #? test: The verify target runs tasks similar to the CI tasks, but without code coverage
 .PHONY: test
@@ -203,5 +201,12 @@ helm-lint:
 	scripts/helm-tools.sh --docs
 
 .PHONY: go-dependency
-go-dependency: ## Dependency maintanance
+#? go-dependency: Dependency maintanance
+go-dependency:
 	go mod tidy
+
+.PHONY: mkdocs-serve
+#? mkdocs-serve: Run the builtin development server for mkdocs
+mkdocs-serve:
+	@$(info "contribute to documentation docs/contributing/dev-guide.md")
+	@mkdocs serve

OWNERS

@@ -9,6 +9,7 @@
 # https://github.com/kubernetes/org/blob/main/config/kubernetes-sigs/sig-network/teams.yaml
 
 approvers:
+  - ivankatliarchuk
   - mloiseleur
   - raffo
   - szuecs
@@ -25,32 +26,3 @@ emeritus_approvers:
   - linki
   - njuettner
   - seanmalloy
-
-filters:
-  "source/":
-    labels:
-    - source
-  "provider/aws(|sd)":
-    labels:
-    - provider/aws
-  "provider/azure":
-    labels:
-    - provider/azure
-  "provider/google":
-    labels:
-    - provider/google
-  "provider/coredns":
-    labels:
-    - provider/coredns
-  "provider/rfc2136":
-    labels:
-    - provider/rfc2136
-  "provider/pdns":
-    labels:
-    - provider/powerdns
-  "provider/cloudflare":
-    labels:
-    - provider/cloudflare
-  "provider/(akamai|alibabacloud|civo|designate|digitalocean|dnsimple|exoscale|gandi|godaddy|ibmcloud|linode|ns1|oci|ovh|pihole|plural|scaleway|tencentcloud|transip|ultradns)":
-    labels:
-    - provider