From f5216deca646f3e3c1c7dcacda95543c98da198b Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Wed, 12 Feb 2025 06:30:50 -0800 Subject: [PATCH 1/4] Ensure TOC stays up-to-date --- .github/workflows/toc-check.yml | 13 +++++++++++++ Makefile | 4 +++- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/toc-check.yml diff --git a/.github/workflows/toc-check.yml b/.github/workflows/toc-check.yml new file mode 100644 index 000000000..0661e22d1 --- /dev/null +++ b/.github/workflows/toc-check.yml @@ -0,0 +1,13 @@ +name: Table of contents checking + +on: + pull_request: + +jobs: + toc-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: check TOC in assets.md + run: make markdown-toc-check diff --git a/Makefile b/Makefile index 5d0ad8fb9..48667a8c2 100644 --- a/Makefile +++ b/Makefile @@ -8,7 +8,6 @@ export MSYS_NO_PATHCONV=1 table-generation: docker run --rm -v ${PWD}:/repo -w /repo python:3-alpine python ./scripts/update-sig-tables.py --install; - validate-sigs: docker run --rm -v ${PWD}:/repo -w /repo python:3-alpine python ./scripts/validate-sigs.py --install; @@ -38,3 +37,6 @@ markdown-toc: echo markdown-toc: no TOC markers, skipping $$f; \ fi; \ done + +markdown-toc-check: markdown-toc + git diff --exit-code ':*.md' || (echo 'Generated markdown Table of Contents is out of date, please run "make markdown-toc" and commit the changes in this PR.' && exit 1) From e53aedd42cb6cb39c4224b40a007fcd68fba92c5 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Wed, 12 Feb 2025 06:34:25 -0800 Subject: [PATCH 2/4] Fix TOC --- assets.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/assets.md b/assets.md index d50feb7c0..9e4749205 100644 --- a/assets.md +++ b/assets.md @@ -11,6 +11,8 @@ This file is intended to list all the assets controlled by OpenTelemetry. - [Community Resource Accounts](#community-resource-accounts) * [AWS account](#aws-account) * [Equinix bare metal](#equinix-bare-metal) + * [GitHub-hosted ARM64 runners](#github-hosted-arm64-runners) + * [Google Cloud account](#google-cloud-account) * [Grafana organization for SIG Security](#grafana-organization-for-sig-security) * [Netlify](#netlify) * [Oracle Cloud account](#oracle-cloud-account) @@ -23,6 +25,7 @@ This file is intended to list all the assets controlled by OpenTelemetry. * [PyPI](#pypi) * [PHP Extras](#php-extras) - [Communication channels](#communication-channels) + * [CNCF Community Group](#cncf-community-group) * [opentelemetry-calendar-contributors Google Group](#opentelemetry-calendar-contributors-google-group) * [OpenTelemetry Calendar Invites Google Group](#opentelemetry-calendar-invites-google-group) * [Mailing list cncf-opentelemetry-net-maintainers@lists.cncf.io](#mailing-list-cncf-opentelemetry-net-maintainerslistscncfio) @@ -37,6 +40,7 @@ This file is intended to list all the assets controlled by OpenTelemetry. * [Easy CLA](#easy-cla) * [Docker Hub](#docker-hub) * [OpenTelemetry Bot](#opentelemetry-bot) + * [Slack](#slack) - [Security](#security) From 1a8d46ebd744ef35964a269b150cb10fcc070ee2 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 17 Feb 2025 08:26:20 -0800 Subject: [PATCH 3/4] fix --- assets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets.md b/assets.md index 72de7f0fd..d21ece2b3 100644 --- a/assets.md +++ b/assets.md @@ -40,7 +40,7 @@ This file is intended to list all the assets controlled by OpenTelemetry. - [Bot accounts](#bot-accounts) * [Easy CLA](#easy-cla) * [Docker Hub](#docker-hub) - * [otelbot](#otelbot) + * [`otelbot`](#otelbot) * [OpenTelemetry Bot](#opentelemetry-bot) * [Slack](#slack) - [Security](#security) From aa2cf046132ef85d996386ba6c5a689b4bd2d4bd Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 17 Feb 2025 08:27:35 -0800 Subject: [PATCH 4/4] add as required check --- .github/repository-settings.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/repository-settings.md b/.github/repository-settings.md index f259eac5f..f1b76f075 100644 --- a/.github/repository-settings.md +++ b/.github/repository-settings.md @@ -18,6 +18,7 @@ settings](../docs/how-to-configure-new-repository.md#repository-settings). * EasyCLA * spelling-check * table-check + * toc-check ### `**/**`