Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (43 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 1.78 KB

Contributing

Setup

git clone https://github.com/zAbuQasem/aws-ssm-action.git
cd aws-ssm-action
bun install

Development

# Type check
bun run typecheck

# Build (outputs dist/index.js)
bun run build

dist/index.js is a fully self-contained bundle — commit it alongside any source changes. The GitHub Actions runner executes it directly.

Commit convention

This project uses Conventional Commits. The changelog and release notes are generated from commit messages, so the format matters.

Prefix Use for
feat: New inputs, outputs, or behaviour
fix: Bug fixes
security: Security improvements
perf: Performance improvements
refactor: Code changes with no behaviour change
docs: README, CONTRIBUTING, comments
chore: Dependencies, CI, tooling

Examples:

feat: add timeout input for long-running commands
fix: reject empty working-directory input
security: mask session token in logs
chore: upgrade @aws-sdk/client-ssm to v3.1100.0

Submitting a pull request

  1. Fork the repository and create a branch from main
  2. Make your changes — run bun run typecheck && bun run build before committing
  3. Commit using the convention above
  4. Open a pull request against main — the lint workflow will typecheck your changes automatically

Releasing

Releases are handled by the release workflow. Maintainers only.

  1. Trigger the workflow manually via Actions → Release → Run workflow, entering the version (e.g. v1.2.3)
  2. The workflow will typecheck, build, tag, and publish the release with auto-generated notes
  3. The CHANGELOG.md is updated automatically after publish via the changelog workflow