Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.68 KB

File metadata and controls

56 lines (38 loc) · 1.68 KB

Contributing

Reporting bugs and requesting features

Before opening a pull request, please open an issue first to discuss what you would like to change. For bugs, include the Xcode version, the Package.resolved snippet that caused the problem, and the full action log.

Development setup

npm ci

Making changes

Source files:

  • src/main.ts — reads inputs and orchestrates the run
  • src/post.ts — cleanup, always runs after the action finishes
  • src/packages.ts — core logic for parsing and comparing Package.resolved
  • src/main.entry.ts — bundle entry point for the main step
  • src/post.entry.ts — bundle entry point for the post step

After modifying source files, rebuild the dist:

npm run build

Commit both the source changes and the updated dist/.

Tests

npm test

Tests live in tests/. Add a test for every new behaviour in src/main.ts and src/packages.ts.

Commit messages

This project follows Conventional Commits:

Prefix When to use
feat: New feature or input/output
fix: Bug fix
perf: Performance improvement
deps: Dependency update
build: Build system changes
docs: Documentation only
test: Tests only
chore: Anything else

Releasing

Releases are created via the Release workflow in GitHub Actions. Provide the version in A.B.C format and the workflow handles tagging, changelog generation and publishing the GitHub Release.