Skip to content

docs: update workflow-docs and README to reference tazama-lf/workflows as canonical source#71

Merged
Sandy-at-Tazama merged 2 commits intodevfrom
docs/update-workflow-docs
Apr 5, 2026
Merged

docs: update workflow-docs and README to reference tazama-lf/workflows as canonical source#71
Sandy-at-Tazama merged 2 commits intodevfrom
docs/update-workflow-docs

Conversation

@Justus-at-Tazama
Copy link
Copy Markdown
Contributor

Summary

Rewrites all workflow-docs/ entries and the README.md to correctly position frmscoe/workflows as a downstream mirror of tazama-lf/workflows, which is the canonical source.


Changes

README.md

  • Repositioned as downstream mirror with explicit "no automated sync" warning
  • Added cascade diagram: tazama-lf/workflows → (manual PR) → frmscoe/workflows → (auto sync on push:dev) → 33 rule repos
  • Added differences table vs tazama-lf/workflows (scope, trigger, segmentation, missing workflows)
  • Added target repo list (33 rule repos)
  • Added workflow-docs index table with status column
  • Added step-by-step guide for applying upstream changes

workflow-docs/ — 13 existing stubs replaced

File New content
codacy.md Redirect stub → tazama-lf docs
codeql.md Redirect stub → tazama-lf docs
conventional-commits.md Redirect stub → tazama-lf docs
dco-check.md Redirect stub + ⚠️ known issue tazama-lf/workflows#37
dependency-review.md Redirect stub → tazama-lf docs
dockerfile-linter.md Not-present notice (no dockerfile-linter.yml in frmscoe)
dockerhub-image-build.md Not-present notice (no dockerhub-image-build.yml in frmscoe)
gpg-verify.md Redirect stub → tazama-lf docs
milestone.md Redirect stub → tazama-lf docs
njsscan.md Redirect stub → tazama-lf docs
nodejs.md Redirect stub + note: NPM_SCOPE=@frmscoe, not synced to target repos
release.md Redirect stub → tazama-lf docs
sync-workflows.md Full unique doc: push: dev trigger, 33 repos, no segmentation, caller stub stamping, frmscoe vs tazama-lf differences

workflow-docs/ — 8 new files

File Content
branch-target-check.md Redirect stub
release-train.md Redirect stub
version-check.md Redirect stub
sbom.md Redirect stub + ⚠️ known issue tazama-lf/workflows#39
scorecard.md Redirect stub + note: no PUBLISH_REPOS exclusion in frmscoe sync
publish.md Full unique doc: @frmscoe scope, dist-tag logic, secrets, sync distribution
package-rule.md Full unique doc: caller stubs reference frmscoe/workflows, rule_org: "frmscoe"
package-rule-rc.md Full unique doc: RC variant, push: dev, caller stub format

Testing

Documentation-only change — no workflow logic modified.

…s as canonical source

- Rewrite README: position as downstream mirror, document cascade from
  tazama-lf/workflows -> this repo -> 33 frmscoe rule repos, diff table vs
  tazama-lf, target repo list, updating instructions, workflow-docs index
- Replace 13 existing stub docs with canonical redirect links to
  tazama-lf/workflows: codacy, codeql, conventional-commits, dco-check
  (known issue #37), dependency-review, gpg-verify, milestone, njsscan,
  nodejs (@frmscoe NPM_SCOPE note), release; dockerfile-linter and
  dockerhub-image-build noted as not present in frmscoe/workflows
- Replace sync-workflows.md with full unique doc: push:dev trigger, 33 repos,
  no segmentation, caller stub stamping, frmscoe vs tazama-lf differences
- Add 8 new docs: branch-target-check, release-train, version-check
  (redirect stubs); sbom (redirect + known issue #39); scorecard (redirect +
  sync note); package-rule, package-rule-rc, publish (frmscoe-specific full
  docs covering @frmscoe scope, caller stubs, rule_org)
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 5, 2026
…ws.md

Change single-column |----------| to two-column |----------|-------| to
match the Property/Value header row (mirrors fix applied to tazama-lf/workflows
in PR #41 review)
@Sandy-at-Tazama Sandy-at-Tazama self-requested a review April 5, 2026 18:36
@Sandy-at-Tazama Sandy-at-Tazama merged commit 291cf14 into dev Apr 5, 2026
2 checks passed
@Sandy-at-Tazama Sandy-at-Tazama deleted the docs/update-workflow-docs branch April 5, 2026 18:37
Justus-at-Tazama added a commit that referenced this pull request Apr 8, 2026
Applies all changes from tazama-lf/workflows PR #76 (workflow audit fixes - batch 1)
to frmscoe/workflows. Changes are synced verbatim from the canonical source.

- fix(njsscan): fix SARIF upload guard, category, upgrade upload-sarif v4 (#68)
- fix(gpg-verify): make curl error handler reachable under bash -e (#69)
- fix(dco-check, gpg-verify): replace mutable branch refs with immutable SHAs (#70)
- fix(package-rule): add ref guard to prevent push from non-canonical branches (#71)
- fix(gpg-verify): rename workflow to Signature Verify, update header comment (#72)
- fix(package-rule): pass GH_TOKEN to docker build via BuildKit secret (#73)
- fix(sbom): pass GH_TOKEN to docker build via BuildKit secret (#74)
- fix(dockerfile-linter): skip hadolint and upload when no Dockerfile present (#75)
- fix(dockerfile-linter, sbom): address CodeRabbit review findings

Signed-off-by: Justus-at-Tazama <jortlepp@contractor.linuxfoundation.org>
Justus-at-Tazama added a commit that referenced this pull request Apr 8, 2026
Applies all changes from tazama-lf/workflows PR #76 (workflow audit fixes - batch 1)
to frmscoe/workflows. Changes are synced verbatim from the canonical source.

- fix(njsscan): fix SARIF upload guard, category, upgrade upload-sarif v4 (#68)
- fix(gpg-verify): make curl error handler reachable under bash -e (#69)
- fix(dco-check, gpg-verify): replace mutable branch refs with immutable SHAs (#70)
- fix(package-rule): add ref guard to prevent push from non-canonical branches (#71)
- fix(gpg-verify): rename workflow to Signature Verify, update header comment (#72)
- fix(package-rule): pass GH_TOKEN to docker build via BuildKit secret (#73)
- fix(sbom): pass GH_TOKEN to docker build via BuildKit secret (#74)
- fix(dockerfile-linter): skip hadolint and upload when no Dockerfile present (#75)
- fix(dockerfile-linter, sbom): address CodeRabbit review findings

Signed-off-by: Justus-at-Tazama <jortlepp@contractor.linuxfoundation.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants