Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure TOC stays up-to-date #2566

Merged
merged 7 commits into from
Feb 17, 2025
Merged

Ensure TOC stays up-to-date #2566

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f5216de
Ensure TOC stays up-to-date
trask Feb 12, 2025
e53aedd
Fix TOC
trask Feb 12, 2025
9396a32
Merge remote-tracking branch 'upstream/main' into toc
trask Feb 13, 2025
6b2bdd0
Merge branch 'main' into toc
trask Feb 17, 2025
8df34f7
Merge remote-tracking branch 'upstream/main' into toc
trask Feb 17, 2025
1a8d46e
fix
trask Feb 17, 2025
aa2cf04
add as required check
trask Feb 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/toc-check.yml
View file
Open in desktop
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
View file
Open in desktop
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)
4 changes: 4 additions & 0 deletions assets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ This file is intended to list all the assets controlled by OpenTelemetry.
* [AWS account](#aws-account)
* [Equinix bare metal](#equinix-bare-metal)
* [FOSSA](#fossa)
* [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)
Expand All @@ -24,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 @@ -39,6 +42,7 @@ This file is intended to list all the assets controlled by OpenTelemetry.
* [Docker Hub](#docker-hub)
* [otelbot](#otelbot)
* [OpenTelemetry Bot](#opentelemetry-bot)
* [Slack](#slack)
- [Security](#security)

<!-- tocstop -->
Expand Down
Loading