Skip to content

Community files, GitHub Release automation, and jazzy-to-DocC migration - #80

Merged
futamura merged 5 commits into
mainfrom
develop
Aug 17, 2026
Merged

Community files, GitHub Release automation, and jazzy-to-DocC migration#80
futamura merged 5 commits into
mainfrom
develop

Conversation

@futamura

Copy link
Copy Markdown
Owner

Summary

  • Community files: add CHANGELOG.md (Keep a Changelog, backfilled from git history), CONTRIBUTING.md, SECURITY.md (GitHub private vulnerability reporting), issue templates, and a PR template.
  • Release automation: release.yml now creates a GitHub Release on tag push, with notes extracted from the tag's CHANGELOG.md section (falling back to generated notes). Tag verification moved to its own job.
  • Docs: migrate jazzy → DocC. scripts/gen_docs.sh extracts symbol graphs with -emit-extension-block-symbols (the public API is entirely String/Substring extensions) and runs docc convert; the new docs.yml workflow builds and deploys the site to GitHub Pages on pushes to main, replacing static.yml and the committed docs/ directory. Package.swift is unchanged.
  • Tooling: bump Ruby to 3.4.10 / Bundler 2.7.2 (fastlane will soon require Ruby ≥ 3.3); drop the jazzy gem, which removes its sqlite3 ~> 1.3 pin and clears the last Dependabot alert (Develop #68) once merged.

Test plan

fastlane drops support for Ruby < 3.3.0 soon. Local tooling only;
CI uses the runner's preinstalled toolchain and does not read
.mise.toml or the Gemfile.
CHANGELOG.md backfills released versions from git history; new
user-facing changes go under Unreleased and feed the GitHub Release
notes. Security reports go through GitHub private vulnerability
reporting instead of public issues.
Release notes come from the tag's CHANGELOG.md section, falling back
to generated notes. Tag verification moves to its own job shared by
the release and CocoaPods publish jobs, so the pod push can be removed
after the trunk goes read-only without touching the rest.
The public API is entirely String/Substring extensions, so symbol
graphs are extracted with -emit-extension-block-symbols; the DocC
plugin route would have required swift-tools 5.8+, which is deferred
to the 4.0 manifest modernization. scripts/gen_docs.sh is shared by
the gen_docs lane and the new docs.yml Pages workflow, replacing the
committed docs/ directory and static.yml.

Dropping the jazzy gem also removes its sqlite3 (~> 1.3) pin, clearing
the last Dependabot alert (#68).
@codecov

codecov Bot commented Aug 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.57%. Comparing base (c939ab3) to head (712ce18).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #80   +/-   ##
=======================================
  Coverage   97.57%   97.57%           
=======================================
  Files           3        3           
  Lines         165      165           
=======================================
  Hits          161      161           
  Misses          4        4           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@futamura
futamura merged commit 44589d2 into main Aug 17, 2026
35 checks passed
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