Skip to content

Post v1.0 cleanup - #94

Merged
sc2ben merged 4 commits into
mainfrom
69-post-10-cleanup
Apr 17, 2026
Merged

sc2ben merged 4 commits into
mainfrom
69-post-10-cleanup

Conversation

@tsunaminoai

@tsunaminoai tsunaminoai commented Apr 17, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Post-1.0 cleanup across CI, documentation, and the CLI.

  • CI consolidation: ci.yml no longer triggers on every branch push - restricted to main and version tags. Combined with a new file-based codeql.yml, this reduces concurrent workflow runs on a PR push from 5 to 3 (CI + CodeQL + Copilot review). Previously, both a push event and a pull_request event fired CI and CodeQL independently on every commit to an open PR.
  • Docs deployment: adds deploy-docs.yml to build and deploy the PolicyPress documentation site to Cloudflare Pages on every push to main.
  • CLI logging: adds --json flag for structured JSON log output (CI-friendly) and -v/--verbose for pandoc argument tracing.
  • README rewrite: leading with the target user persona, simplified quickstart pointing at the template repo, updated CLI reference with new flags, removed zap from the dependency table.
  • Docs updates: installation guide improvements; configuration guide gains a favicon section.

Manual step after merge

Disable GitHub's default CodeQL setup to avoid running alongside the new codeql.yml:

Settings → Security → Code security → Code scanning → Default setup → Disable

Test plan

  • Push a commit to this PR branch - confirm Actions tab shows 1 CI run + 1 CodeQL, not 2 of each
  • Merge to main - confirm CI, docs deploy, and CodeQL each run once
  • Verify Cloudflare Pages deployment succeeds and the docs site reflects the updated content
  • Disable GitHub default CodeQL setup per the manual step above; confirm code scanning results still populate from the new workflow

- Wire -v/--verbose to debug log level (removes TODO comment)
- Add -q/--quiet to suppress progress output (errors only)
- Add --json to emit structured JSON lines to stderr for CI
- Migrate progress std.debug.print calls to std.log so they
  respect the configured level
- Update README: CI/release badges, small business user story,
  template repo quick start, fix stale [extra] config example
- Update installation guide: lead with policypress-template,
  align GHA example with template's actual workflow
@tsunaminoai tsunaminoai linked an issue Apr 17, 2026 that may be closed by this pull request
6 of 11 tasks
@sc2ben
sc2ben self-requested a review April 17, 2026 17:58
@sc2ben
sc2ben merged commit ff7a871 into main Apr 17, 2026
5 checks passed
@sc2ben
sc2ben deleted the 69-post-10-cleanup branch April 17, 2026 18:01
tsunaminoai added a commit that referenced this pull request Apr 17, 2026
* feat: logging improvements and documentation updates

- Wire -v/--verbose to debug log level (removes TODO comment)
- Add -q/--quiet to suppress progress output (errors only)
- Add --json to emit structured JSON lines to stderr for CI
- Migrate progress std.debug.print calls to std.log so they
  respect the configured level
- Update README: CI/release badges, small business user story,
  template repo quick start, fix stale [extra] config example
- Update installation guide: lead with policypress-template,
  align GHA example with template's actual workflow

* fix: restrict CI workflow to main branch and add CodeQL analysis and deploy docs workflows

* fix: update package version to 1.2.0

* fix: remove CodeQL workflow configuration since this is a zig project
@sc2ben

sc2ben commented Apr 17, 2026

Copy link
Copy Markdown
Member

Successfully rolled out to https://policypress.sc2.in

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.

Post-1.0 Cleanup

2 participants