diff --git a/.github/workflows/checks.yaml b/.github/workflows/checks.yaml index 48fcdcd8c..4eb314fe4 100644 --- a/.github/workflows/checks.yaml +++ b/.github/workflows/checks.yaml @@ -14,10 +14,7 @@ jobs: strategy: matrix: os: - # TODO(simonpasquier): enable the job for macos platforms. - # It's been disabled because mdox fails to query the GitHub API - # server (which returns 403 Forbidden). - #- macos-latest + - macos-latest - ubuntu-latest name: Generate and format steps: @@ -29,6 +26,8 @@ jobs: go-version: '${{ env.golang-version }}' check-latest: true - run: make --always-make format generate && git diff --exit-code + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} check-docs: runs-on: ubuntu-latest @@ -42,6 +41,8 @@ jobs: go-version: '${{ env.golang-version }}' check-latest: true - run: make check-docs + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} check-golang: runs-on: ubuntu-latest @@ -92,6 +93,7 @@ jobs: go-version: '${{ env.golang-version }}' check-latest: true - run: make operator + po-rule-migration: runs-on: ubuntu-latest name: Build Prometheus Operator rule config map to rule file CRDs CLI tool @@ -104,4 +106,3 @@ jobs: go-version: '${{ env.golang-version }}' check-latest: true - run: cd cmd/po-rule-migration && go install - diff --git a/.mdox.validate.yaml b/.mdox.validate.yaml index b58bac106..cb1def723 100644 --- a/.mdox.validate.yaml +++ b/.mdox.validate.yaml @@ -34,3 +34,5 @@ validators: # Use the githubPullsIssues validator to avoid rate-limiting. - regex: '(^http[s]?:\/\/)(www\.)?(github\.com\/)prometheus-operator\/prometheus-operator(\/pull\/|\/issues\/)' type: githubPullsIssues + # The GitHub actions running mdox configure the GITHUB_TOKEN environment variable. + token: '$(GITHUB_TOKEN)' diff --git a/Makefile b/Makefile index 99da697a9..60ad9c111 100644 --- a/Makefile +++ b/Makefile @@ -47,7 +47,6 @@ MDOX_BINARY=$(TOOLS_BIN_DIR)/mdox API_DOC_GEN_BINARY=$(TOOLS_BIN_DIR)/gen-crd-api-reference-docs TOOLING=$(CONTROLLER_GEN_BINARY) $(GOBINDATA_BINARY) $(JB_BINARY) $(GOJSONTOYAML_BINARY) $(JSONNET_BINARY) $(JSONNETFMT_BINARY) $(SHELLCHECK_BINARY) $(PROMLINTER_BINARY) $(GOLANGCILINTER_BINARY) $(MDOX_BINARY) $(API_DOC_GEN_BINARY) - K8S_GEN_BINARIES:=informer-gen lister-gen client-gen applyconfiguration-gen K8S_GEN_ARGS:=--go-header-file $(shell pwd)/.header --v=1 --logtostderr @@ -68,6 +67,7 @@ else BUILD_BRANCH=$(GITHUB_REF:refs/heads/%=%) BUILD_REVISION=$(GITHUB_SHA) endif +GITHUB_TOKEN?= # The Prometheus common library import path PROMETHEUS_COMMON_PKG=github.com/prometheus/common @@ -327,12 +327,12 @@ MD_FILES_TO_FORMAT=$(filter-out $(FULLY_GENERATED_DOCS), $(shell find Documentat .PHONY: docs docs: $(MDOX_BINARY) @echo ">> formatting and local/remote link check" - $(MDOX_BINARY) fmt --soft-wraps -l --links.localize.address-regex="https://prometheus-operator.dev/.*" --links.validate.config-file=$(MDOX_VALIDATE_CONFIG) $(MD_FILES_TO_FORMAT) + GITHUB_TOKEN=$(GITHUB_TOKEN) $(MDOX_BINARY) fmt --soft-wraps -l --links.localize.address-regex="https://prometheus-operator.dev/.*" --links.validate.config-file=$(MDOX_VALIDATE_CONFIG) $(MD_FILES_TO_FORMAT) .PHONY: check-docs check-docs: $(MDOX_BINARY) @echo ">> checking formatting and local/remote links" - $(MDOX_BINARY) fmt --soft-wraps --check -l --links.localize.address-regex="https://prometheus-operator.dev/.*" --links.validate.config-file=$(MDOX_VALIDATE_CONFIG) $(MD_FILES_TO_FORMAT) + GITHUB_TOKEN=$(GITHUB_TOKEN) $(MDOX_BINARY) fmt --soft-wraps --check -l --links.localize.address-regex="https://prometheus-operator.dev/.*" --links.validate.config-file=$(MDOX_VALIDATE_CONFIG) $(MD_FILES_TO_FORMAT) ########### # Testing #