Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Documentation checks

on:
pull_request:
paths:
- '**/*.md'
push:
branches: [main]
paths:
- '**/*.md'

permissions:
contents: read

jobs:
links-and-claims:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
- name: Reject workstation-only links and unsupported superlatives
shell: bash
run: |
set -euo pipefail
! grep -RInE 'file:///' --include='*.md' .
! grep -RInE 'production-grade|enterprise-grade|expert-level|staff-level|bulletproof' --include='*.md' .
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,9 @@ that pool, avoiding a single-account bottleneck. Full non-local workloads also r
- Security CI runs npm audit, creates a CycloneDX SBOM, and scans the lockfile with OSV.
- [Published performance reports](https://qa-test-automation-frameworks.github.io/k6-performance-framework/)

This is the most CI-heavy repository in the portfolio; see the [CI workflow map](docs/ci-map.md)
for what each workflow is for and why it exists as a separate gate.

## Documentation

- [Architecture](docs/architecture.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/adr/001-language-typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ The project requires a build step before k6 execution. Contributors must maintai
| Option | Pros | Cons | Rejected Because |
| ---------- | ----------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
| JavaScript | Native k6 authoring, no compile step | Weaker contracts, fewer guardrails, less portfolio signal | Does not meet the strict typing and maintainability goals |
| TypeScript | Strong types, IDE support, zero runtime cost after bundling | Requires build tooling | Best fit for production-grade maintainability |
| TypeScript | Strong types, IDE support, zero runtime cost after bundling | Requires build tooling | Best fit for long-term maintainability and review clarity |