Skip to content

feat: automating the references and their injection in the wiki#246

Open
farah-t-trigui wants to merge 1 commit intomainfrom
feat/references-in-repositories-wiki
Open

feat: automating the references and their injection in the wiki#246
farah-t-trigui wants to merge 1 commit intomainfrom
feat/references-in-repositories-wiki

Conversation

@farah-t-trigui
Copy link
Copy Markdown
Contributor

@farah-t-trigui farah-t-trigui commented Apr 7, 2026

Related Issue

Closes #224

What does this PR do?

This PR introduces placeholder-based variable injection into the wiki publishing pipeline:

  • Adds {{RELEASE_TAG}} and {{DOCKER_TAG}} placeholders in the relevant wiki markdown files (Installation.md, Specification-Schema.md, Specification-Rules.md, Tutorial-Part-1.md)
  • Updates the Publish Wiki GitHub Actions workflow to:
    • Resolve the latest release tag
    • Compute the Docker image tag from the current commit SHA
    • Substitute both placeholders in all .md files before pushing to the wiki

Checklist

  • CI is green (build, tests, schema validation, security scans)
  • Rebased on latest main
  • Small and focused — one concern per PR
  • Commit messages follow Conventional Commits

@farah-t-trigui farah-t-trigui requested a review from eskenazit April 7, 2026 13:25
@farah-t-trigui farah-t-trigui force-pushed the feat/references-in-repositories-wiki branch 3 times, most recently from 8ba28f8 to 90236dd Compare April 7, 2026 14:08
@eskenazit eskenazit force-pushed the feat/references-in-repositories-wiki branch from 90236dd to 0cc91f5 Compare April 7, 2026 15:52

echo "Cloning wiki"
git clone "$GIT_REPOSITORY_URL" "$tmp_dir" || mkdir -p "$tmp_dir"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

|| mkdir -p "$tmp_dir" is masking a potential git clone error. push wil then likely fail later on wirhout giving any clue on why. We should rather exit properly at that level if git clone is failing.

env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
RELEASE_TAG=$(gh release list --limit 1 --json tagName -q '.[0].tagName' 2>/dev/null || echo "unreleased")
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

If the action cannot find any release it is pointless and should exit immedialtely ! =)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants