Skip to content

Commit 08e4eec

Browse files
authored
Define and adopt Phase 2b negotiated Markdown semantics, rework and complete test coverage, and more (#9632)
1 parent 728167a commit 08e4eec

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2263
-601
lines changed

.cspell/en-words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ Socha
127127
Stalnaker
128128
stdoutmetric
129129
Strimzi
130+
subresponse
130131
symfony
131132
tabpane
132133
textlint

.github/workflows/check-text.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
name: Linter # cSpell:ignore yargs
1+
name: Linter
2+
3+
# cSpell:ignore startswith yargs
24

35
on:
46
merge_group:

.github/workflows/test.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Tests
2+
3+
# Scope: runs the `test:*-*` scripts grouped by `test:compound-tests` in
4+
# package.json (e.g. edge-function and redirect live checks). It does not run
5+
# `test:base`, which is currently `npm run check` / `check:all`; those are
6+
# covered elsewhere (check-file, check-links, check-text, spelling, i18n, …).
7+
8+
on:
9+
merge_group:
10+
pull_request:
11+
12+
permissions:
13+
contents: read
14+
15+
jobs:
16+
test:
17+
name: 'TEST (excluding test:base)'
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v6
21+
22+
- uses: actions/setup-node@v6
23+
with:
24+
node-version-file: .nvmrc
25+
26+
- run: npm install --ignore-scripts --omit=optional
27+
28+
- run: npm run test:compound-tests

content/en/docs/contributing/pr-checks.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Pull request checks
2+
title: Pull request checks and tests
33
description: Learn how to make your pull request successfully pass all checks
44
weight: 40
55
---
@@ -179,3 +179,9 @@ The following code enforces the link requirement described in this section:
179179
[`scripts/content-modules/adjust-pages.pl`](https://github.com/open-telemetry/opentelemetry.io/blob/main/scripts/content-modules/adjust-pages.pl)
180180
181181
</details>
182+
183+
### `TEST (excluding test:base)` {.notranslate lang=en}
184+
185+
Runs `npm run test:compound-tests`, which executes the compound `test:*-*` NPM
186+
scripts (for example, Netlify edge-function tests). It does **not** run
187+
`test:base`.

content/en/ecosystem/registry/_index.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,12 @@ weight: 20
1515
# =============================================================================
1616

1717
aliases: [/registry/*]
18-
outputs: [HTML, JSON]
19-
20-
# The redirects and aliases implement catch-all rules for old registry entries;
21-
# we don't publish individual entry pages anymore.
22-
#
23-
# We can't use the catch-all `/ecosystem/registry/*`, because that creates a
24-
# self-loop with `/ecosystem/registry/index.html`. So we use the following
25-
# redirect rule to avoid the loop, as suggested by Netlify support
26-
# (email support ID 159489):
27-
redirects: [{ from: /ecosystem/registry*, to: '/ecosystem/registry?' }]
18+
outputs: [HTML, markdown, JSON]
19+
20+
# TODO(chalin): move the following comment into the site docs, then add a link
21+
# to it here. Old /ecosystem/registry/<component> URLs are handled by the
22+
# `registry-component-redirect` Netlify Edge Function (replaces the Hugo
23+
# catch-all redirect; see https://github.com/open-telemetry/opentelemetry.io/issues/9633).
2824
---
2925

3026
{{% blocks/lead color="dark" %}}

content/en/search.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
title: Search Results
33
layout: search
4-
outputs: [HTML]
54
---

content/en/site/build/ci-workflows.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,9 +273,10 @@ The repository includes several other workflows:
273273
| `check-text.yml` | Textlint terminology checks |
274274
| `check-i18n.yml` | Localization front matter validation |
275275
| `check-spelling.yml` | Spell checking |
276+
| `test.yml` | Test (excludes `test:base`) |
276277
| `auto-update-registry.yml` | Auto-update registry package versions |
277278
| `auto-update-versions.yml` | Auto-update OTel component versions |
278279
| `build-dev.yml` | Development build and preview |
279280
| `lint-scripts.yml` | ShellCheck linting for `.github/scripts/` |
280-
| `label-prs.yml` | Auto-label PRs based on file paths |
281+
| `label-manager.yml` | PR labels (component labels & approval flow) |
281282
| `component-owners.yml` | Assign reviewers based on component ownership |

content/en/site/build/npm-scripts.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -85,19 +85,20 @@ are internal helpers and are not intended to be run directly.
8585

8686
## Test and CI
8787

88-
| Script | Description |
89-
| -------------------------- | ------------------------------------------------------------------- |
90-
| `test` | Run the most commonly needed tests. |
91-
| `test:base` | Base tests. |
92-
| `test:all` | Runs `test:base`, `test:collector-sync`, and `test:edge-functions`. |
93-
| `test:collector-sync` | Collector-sync tests. |
94-
| `test:edge-functions` | Node test runner over `netlify/edge-functions/**/*.test.ts`. |
95-
| `test:edge-functions:live` | Optional `node:test` live suite; supports `--help`. |
96-
| `test-and-fix` | Run fix scripts (excluding i18n/refcache/submodule), then checks. |
97-
| `diff:check` | Warn if working tree has uncommitted changes. |
98-
| `diff:fail` | Fail if working tree has changes (e.g. after build). |
99-
| `netlify-build:preview` | `build:preview` then `diff:check`. |
100-
| `netlify-build:production` | `build:production` then `diff:check`. |
88+
| Script | Description |
89+
| -------------------------- | ----------------------------------------------------------------- |
90+
| `test` | Run the most commonly needed tests. |
91+
| `test:base` | Base tests (same as `check`). |
92+
| `test:compound-tests` | Runs compound `test:*-*` scripts. |
93+
| `test:all` | Runs `test:base` then `test:compound-tests`. |
94+
| `test:collector-sync` | Collector-sync tests. |
95+
| `test:edge-functions` | Node test runner over `netlify/edge-functions/**/*.test.ts`. |
96+
| `test:edge-functions:live` | Optional `node:test` live suite; supports `--help`. |
97+
| `test-and-fix` | Run fix scripts (excluding i18n/refcache/submodule), then checks. |
98+
| `diff:check` | Warn if working tree has uncommitted changes. |
99+
| `diff:fail` | Fail if working tree has changes (e.g. after build). |
100+
| `netlify-build:preview` | `build:preview` then `diff:check`. |
101+
| `netlify-build:production` | `build:production` then `diff:check`. |
101102

102103
## Utilities
103104

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: HTML-only test page
33
outputs: [HTML]
4+
aliases: [no-md-alias]
45
---
56

67
This is a test page.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Regular test page
3+
aliases: [regular-alias]
34
---
45

56
This is a test page.

0 commit comments

Comments
 (0)