Skip to content

ci(repository): accept a real CI workflow in place of the example - #5

Merged
PerfectPan merged 1 commit into
mainfrom
ci/allow-real-ci-workflow
Sep 30, 2026
Merged

PerfectPan merged 1 commit into
mainfrom
ci/allow-real-ci-workflow

Conversation

@PerfectPan

Copy link
Copy Markdown
Owner

Title format: type(scope): summary

Summary

  • check-repository.sh accepts .github/workflows/ci.yml or .github/workflows/ci.yml.example.

Motivation

  • Repositories created from the template replace the CI example with a real workflow. Requiring the example forced downstream repos to keep a stale copy.

Implementation Notes

  • required_files entries may list alternatives separated by |; the missing-file message prints them joined with "or".
  • README setup step 6 now says to replace the example.

Validation

  • Repository checks: ./scripts/check-repository.sh and --staged pass.
  • With only ci.yml present: pass. With neither file: fails with .github/workflows/ci.yml or .github/workflows/ci.yml.example.
  • bash -n scripts/check-repository.sh

Skipped gates and reasons:

  • No stack-specific format, lint, test, or build in this template.

Evidence

  • Local runs listed above.

Safety Checklist

  • No credentials, tokens, private hostnames, personal filesystem paths, or generated logs are included.
  • Local config, generated output, build artifacts, and temporary workspaces are not staged.
  • User-facing behavior, docs, changelog, migrations, or rollback notes are updated when relevant.
  • Completed Spec/Plan constraints are migrated to tests or current-state docs before retirement; unfinished scope remains active.
  • The branch is current enough for review, and the remote head matches the intended commit.

Follow-up Risks

  • None.

Projects created from the template replace ci.yml.example with their
own ci.yml. Requiring the example kept a stale copy in downstream repos.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@PerfectPan
PerfectPan merged commit e26915a into main Sep 30, 2026
3 checks passed
@PerfectPan
PerfectPan deleted the ci/allow-real-ci-workflow branch September 30, 2026 17:21
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.

1 participant