Browse Source

fix(release): remove docs.check and all relative calls (#6146)

Co-authored-by: Gergely Bräutigam <gergely.brautigam@sap.com>
Jaruwat Panturat 2 weeks ago
parent
commit
2f6db6c5b7
4 changed files with 1 additions and 53 deletions
  1. 0 43
      .github/workflows/release.yml
  2. 0 4
      Makefile
  3. 1 0
      docs/contributing/release.md
  4. 0 6
      hack/api-docs/Makefile

+ 0 - 43
.github/workflows/release.yml

@@ -19,49 +19,6 @@ permissions:
   contents: read
 
 jobs:
-  check-docs-for-release:
-    name: Check Docs for release
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    steps:
-      - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@fa2e9d605c4eeb9fcad4c99c224cee0c6c7f3594 # v2.16.0
-        with:
-          egress-policy: audit
-
-      - name: Checkout
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          fetch-depth: 0
-
-      - name: Resolve and validate ref
-        id: resolve_ref
-        env:
-          SOURCE_REF: ${{ github.event.inputs.source_ref }}
-        run: |
-          set -e
-          # Try to fetch the ref from remote
-          if git fetch origin "$SOURCE_REF"; then
-            # Remote ref exists, use it
-            RESOLVED_SHA=$(git rev-parse "origin/$SOURCE_REF")
-          elif git rev-parse --verify "$SOURCE_REF" >/dev/null 2>&1; then
-            # Local ref exists (e.g., a tag)
-            RESOLVED_SHA=$(git rev-parse "$SOURCE_REF")
-          else
-            echo "Error: ref '$SOURCE_REF' not found"
-            exit 1
-          fi
-          echo "Resolved to SHA: $RESOLVED_SHA"
-          echo "sha=$RESOLVED_SHA" >> $GITHUB_OUTPUT
-
-      - name: Checkout validated ref
-        run: git checkout ${{ steps.resolve_ref.outputs.sha }}
-      - name: check-docs
-        env:
-          DOCS_VERSION: ${{ github.event.inputs.version }}
-        run: |
-          make docs.check
   release:
     name: Create Release
     runs-on: ubuntu-latest

+ 0 - 4
Makefile

@@ -300,10 +300,6 @@ docs.serve: ## Serve docs
 	$(MAKE) -C ./hack/api-docs serve
 
 DOCS_VERSION ?= $(VERSION)
-.PHONY: docs.check
-docs.check: ## Check docs
-	$(MAKE) -C ./hack/api-docs check DOCS_VERSION=$(DOCS_VERSION)
-
 .PHONY: docs.update
 docs.update: ## Update docs
 	$(MAKE) -C ./hack/api-docs stability-support.update DOCS_VERSION=$(DOCS_VERSION)

+ 1 - 0
docs/contributing/release.md

@@ -31,6 +31,7 @@ When doing a release it's best to start with  with the ["Create Release" issue t
 ⚠️ Note: when releasing multiple versions, make sure to first release the "old" version, then the newer version.
 Otherwise the `latest` documentation will point to the older version. Also avoid to release both versions at the same time to avoid race conditions in the CI pipeline (updating docs, GitHub Release, helm chart release).
 
+1. Make sure the [stability & support page](https://external-secrets.io/main/introduction/stability-support/) is up to date. The new version should be listed in the version table before proceeding with the release.
 1. Make sure there is no pending CI jobs running. This is to avoid promoting a stale image to a new version (we need to rely on _existing_ pushed images for release).
 1. Run `Create Release` Action to create a new release, pass in the desired version number to release.
     1. choose the right `branch` to execute the action: use `main` when creating a new release.

+ 0 - 6
hack/api-docs/Makefile

@@ -20,7 +20,6 @@ DOCS_VERSION ?= main
 VERSION_NO_V ?= $(shell echo $(DOCS_VERSION) | cut -d'v' -f2)
 MAJOR_VERSION ?= $(shell echo $(VERSION_NO_V) | cut -d'.' -f1)
 MINOR_VERSION ?= $(shell echo $(VERSION_NO_V) | cut -d'.' -f2)
-VERSION_TO_CHECK ?= $(shell echo $(MAJOR_VERSION).$(MINOR_VERSION))
 DOCS_ALIAS ?= unstable
 GITHUB_TOKEN ?= invalid
 SERVE_BIND_ADDRESS ?= 127.0.0.1
@@ -56,11 +55,6 @@ VERSION_TO_UPDATE ?= $(shell echo $(MAJOR_VERSION).$(MINOR_VERSION).x)
 stability-support.update:
 	ROOT=$(ROOT) ./add_eso_version.sh $(VERSION_TO_UPDATE)
 
-.PHONY: check
-check:
-	@echo "Checking for version: $(VERSION_TO_CHECK)"
-	cat $(ROOT)/docs/introduction/stability-support.md | grep "$(VERSION_TO_CHECK)"
-
 .PHONY: build
 build: image generate $(SOURCES)
 	mkdir -p $(GENROOT)