Skip to content

Commit

Permalink
Ensure TOC stays up-to-date (#2566)
Browse files Browse the repository at this point in the history
* Ensure TOC stays up-to-date

* Fix TOC

* fix

* add as required check
  • Loading branch information
trask authored Feb 17, 2025
1 parent 6efe28d commit 679f436
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/repository-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ settings](../docs/how-to-configure-new-repository.md#repository-settings).
* EasyCLA
* spelling-check
* table-check
* toc-check

### `**/**`

Expand Down
13 changes: 13 additions & 0 deletions .github/workflows/toc-check.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -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)
5 changes: 4 additions & 1 deletion assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This file is intended to list all the assets controlled by OpenTelemetry.
* [Equinix bare metal runners](#equinix-bare-metal-runners)
* [FOSSA](#fossa)
* [GitHub Actions large runners](#github-actions-large-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)
Expand All @@ -25,6 +26,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 [email protected]](#mailing-list-cncf-opentelemetry-net-maintainerslistscncfio)
Expand All @@ -38,8 +40,9 @@ 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)

<!-- tocstop -->
Expand Down

0 comments on commit 679f436

Please sign in to comment.