docs: fix template marker documentation drift#761
Merged
jamesadevine merged 1 commit intoMay 26, 2026
Conversation
- Add documentation for {{ stage_prefix }} marker used in job-base.yml and stage-base.yml
- Add documentation for {{ template_parameters }} marker used in job-base.yml and stage-base.yml
- Remove obsolete {{ pipeline_path }} and {{ trigger_repo_directory }} marker documentation (no longer used in any template)
- Mark {{ mcp_client_config }} as obsolete in the heading
These markers are actively used in the job and stage templates but were not documented,
while the obsolete markers were still documented as if they were current.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Collaborator
|
@copilot can you make a github issue to analyse and sweep up the unused or outdated markers listed here? |
Contributor
I can’t create the issue directly from this environment because GitHub auth for issue creation is unavailable here. Please create one with: Title: Sweep unused/outdated template markers Body:
|
jamesadevine
approved these changes
May 26, 2026
jamesadevine
deleted the
docs/fix-template-marker-documentation-02c8b28479feb18d
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Freshness Audit
This audit found the following inconsistencies between code and documentation:
Findings
Details
Missing documentation:
{{ stage_prefix }}— used in src/data/job-base.yml and src/data/stage-base.yml to generate unique job/stage names{{ template_parameters }}— used in src/data/job-base.yml and src/data/stage-base.yml to emit the top-level parameters blockObsolete marker documentation:
{{ pipeline_path }}— no longer used in any template file{{ trigger_repo_directory }}— no longer used in any template file{{ mcp_client_config }}— documented as removed but still listed among current markersApplied Fixes
This pull request was created by the automated documentation freshness check.