White Pawn

White Pawn shows a white chess pawn (♙).

White Pawn is a reusable Swift 6 module. It provides:

• A Swift Package Manager library and tests
• An example SwiftUI app in an Xcode project
• Semantic versioning, a CHANGELOG, and an MIT license
• GitHub Actions testing with the workflows published for Swift packages
• EditorConfig, a .gitignore, and enforced formatting

The example app shows a white pawn (♙).

Clone the repo and open Example/Example.xcodeproj. Run the Example scheme on a recent iPhone simulator.

Add this package with Swift Package Manager. In Xcode that is File > Add Package Dependencies...

Format the files the lint workflow checks. These commands use npx at @latest so the local write matches .github/workflows/lint.yml. A pinned package would let the local write and the CI check disagree.

npx prettier@latest --write .
npx markdownlint-cli@latest --fix "**/*.md" --ignore node_modules

Add the package to an app and call the library. The example app in Example/ shows a white chess pawn (♙).

We are people who publish reusable Swift modules. White Pawn is one module: a Swift package, tests, and an example app.

We specifically will not add a second product, a server, or a package registry release. Swift Package Manager uses the git tag.

Run the test suite with:

xcrun swift test

Use fix:, feat: or BREAKING CHANGE: in your commit messages. This triggers our bot to make a release draft pull request. Merging that pull request triggers a new tag and GitHub Release.

The release workflow uses Release Please with the simple release type. .release-please-manifest.json is the last released version. Release Please writes CHANGELOG.md on the release pull request. Commit messages follow Conventional Commits 1.0.0.

Build and test builds and tests a release-mode Linux library, then attests and uploads it. The release includes that library and release.sigstore.jsonl, containing build provenance and version attestations. The published library is for Linux. Swift Package Manager uses the git tag.

gh api repos/{owner}/{repo}/tags --jq '.[].name'

gh api --method POST repos/{owner}/{repo}/git/refs \
  -f ref="refs/tags/v0.0.0" \
  -f sha="$(gh api repos/{owner}/{repo}/commits/main --jq .sha)"

Do this every quarter or so and please send a PR here if you see updates available:

1. Identify external Actions in .github/workflows scripts and look for available new versions. Review and then update to the new version if it is safe. GitHub-supported Actions (i.e. under the actions/ organization) may require only cursory review.
2. Review the Swift versions in .github/workflows/swiftlang-workflows.yml. The package requires the tools version in Package.swift.
3. Review the RECIPE and confirm that the current latest pubished version of Xcode equals the version asserted at the top of this file. If not, redo the recipe.

1. We use title case only for proper nouns, including the name of our project.
2. We use an MIT license for this template. You should carefully consider which license to apply to your own project.
3. Swift ignore rules are inlined from Swift.gitignore. The macOS and secret rules above them come from project-template.
4. This project is built based on best practices documented in Swift 6 Module Template.
5. This project is built based on best practices documented in project-template, release v1.3.0.
6. Releases follow the project-template release workflow, release v1.3.0. The published file is the Linux static library from swift build -c release. project-template publishes README.md there, and rust-template publishes its command-line binary.