Skip to content

📖 [Docs]: Test instructions updated to document per-test-file repository model#598

Merged
Marius Storhaug (MariusStorhaug) merged 1 commit intomainfrom
docs/test-instructions-per-test-repos
May 3, 2026
Merged

📖 [Docs]: Test instructions updated to document per-test-file repository model#598
Marius Storhaug (MariusStorhaug) merged 1 commit intomainfrom
docs/test-instructions-per-test-repos

Conversation

@MariusStorhaug
Copy link
Copy Markdown
Member

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented May 3, 2026

Test instructions now document the per-test-file repository model — each test file owns its own repository, handles idempotent setup, cleans stale resources, and tears down after itself. Contributors following the instructions will correctly scope their tests to avoid cross-file interference during parallel execution.

Changed: Repository naming and ownership model

The instructions previously described a shared Test-{OS}-{TokenType}-{RunID} repository used by all test files. Each test file now owns its own repository using the pattern {TestName}-{OS}-{TokenType}-{RunID}, preventing resource collisions when tests run in parallel across OS matrices.

Resource Pattern Example
Repo {TestName}-{OS}-{TokenType}-{RunID} Releases-Linux-USER_FG_PAT-1234
Extra repo {TestName}-{OS}-{TokenType}-{RunID}-{N} Secrets-Linux-ORG_FG_PAT-1234-2

New: Self-containment principle

Each test file is now documented as fully self-contained:

  1. BeforeAll ensures the test repository exists (idempotent creation) and cleans stale resources from prior runs with the same GITHUB_RUN_ID
  2. AfterAll tears down all test-specific resources
  3. Tests must work independently across parallel OSes and sequential auth contexts

Technical Details

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 3, 2026

No Significant Changes Detected

This PR does not contain changes to files that would trigger a new release:

Path Description
src/** Module source code
README.md Documentation

Build, test, and publish stages will be skipped for this PR.

If you believe this is incorrect, please verify that your changes are in the correct locations.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 3, 2026

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@MariusStorhaug Marius Storhaug (MariusStorhaug) marked this pull request as ready for review May 3, 2026 11:14
@MariusStorhaug Marius Storhaug (MariusStorhaug) requested a review from a team as a code owner May 3, 2026 11:14
Copilot AI review requested due to automatic review settings May 3, 2026 11:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This docs-only PR updates the integration test instructions to describe a per-test-file repository model and a self-contained test lifecycle for files under tests/. The goal is to guide contributors and automation toward better test isolation during parallel runs.

Changes:

  • Updates the instruction frontmatter and setup/teardown guidance to describe per-test-file repository ownership.
  • Rewrites the example test-file structure to show repo provisioning plus stale-resource cleanup/teardown responsibilities.
  • Replaces the repository naming rules and key rules with {TestName}-{OS}-{TokenType}-{RunID}-based guidance.

Comment thread .github/instructions/tests.instructions.md
Comment thread .github/instructions/tests.instructions.md
Comment thread .github/instructions/tests.instructions.md
Comment thread .github/instructions/tests.instructions.md
@MariusStorhaug Marius Storhaug (MariusStorhaug) merged commit 89c975a into main May 3, 2026
45 of 46 checks passed
@MariusStorhaug Marius Storhaug (MariusStorhaug) deleted the docs/test-instructions-per-test-repos branch May 3, 2026 12:00
@github-project-automation github-project-automation Bot moved this from Todo to Done in GitHub PowerShell Module May 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Update tests.instructions.md to document per-test-file repository model

2 participants