Skip to content

ci: add reusable GitHub workflows and document caller usage#1

Merged
rachelauryn merged 6 commits into
mainfrom
workflows
Jun 1, 2026
Merged

ci: add reusable GitHub workflows and document caller usage#1
rachelauryn merged 6 commits into
mainfrom
workflows

Conversation

@mrmaloof

@mrmaloof mrmaloof commented May 26, 2026

Copy link
Copy Markdown
Contributor

Description

Adds org-wide reusable GitHub Actions workflows under .github/workflows/ and documents how repos opt in:

Workflow Purpose
link-asana-task Requires Asana task URL in PR and links to Asana
enforce-pr-targets PRs to main only from release/* or hotfix/*
pr-title Conventional Commits PR titles
pre-release CHANGELOG.md required on PRs to main
dependency-review Dependency Review on pull requests

Updates README.md with a workflow table and minimal caller examples.
No app repos are wired up yet — this PR only adds the shared workflow and docs.

Deployment Readiness*

Testing

Describe or check:

  • Created or updated unit, feature, and/or integration tests
  • Typical manual testing in the local env browser, dev pipeline, etc.

Deployment Notes

Describe or check:

  • No special deployment steps required

Rollback Plan

Describe or check:

  • Standard revert is sufficient (git revert)

Reviewer Guidance / Questions*

  • This does not change branch protection or rulesets — it only provides a workflow repos can call.

Screenshots / Testing Evidence*

N/A — infrastructure-only change.

SOC 2 Change Management Checklist

  • None of the below are true in this code
  • New roles/permissions are introduced without review and approval by the product manager
  • Hardcoded credentials, secrets, or API keys are present in this code
  • Secrets are being managed outside of the approved secrets management process (e.g., GitHub Secrets, environment variables)
  • PII or sensitive data handling is introduced or changed without being reviewed against our data classification policy
  • Sensitive data is written to logs
  • Input validation and sanitization is missing
  • An unnecessary attack surface has been introduced (e.g., unused endpoints, open ports, debug modes left enabled)
  • Common vulnerabilities have been introduced in the code (inc. any dependencies added or updated)
  • No review for common vulnerabilities has been conducted
  • Not tested in a non-production environment
  • Breaking changes to existing APIs or integrations with downstream consumers being notified
  • Performance impact has not been considered or acceptable
  • Appropriate audit logging is missing for any security-relevant actions introduced by this change
  • Log entries contain sensitive or PII data
  • All existing tests do not pass locally (./vendor/bin/pest)

Provide justification if you are submitting a PR with any boxes checked other than the first.


Reminder for Reviewers: By approving this PR you are confirming that you have reviewed the code for correctness, security, and compliance with our engineering and SOC 2 standards. Do not approve PRs where SOC 2 checklist items are checked without documented justification.

*Optional


@mrmaloof mrmaloof requested a review from rachelauryn May 26, 2026 21:17
@mrmaloof mrmaloof changed the title ci: add reusable enforce-pr-targets workflow and document caller usage ci: add reusable GitHub workflows and document caller usage May 26, 2026

@rachelauryn rachelauryn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just 1 small edit please to add "security"!

perf
refactor
revert
style

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add security

@mrmaloof

Copy link
Copy Markdown
Contributor Author

@rachelauryn, I added another workflow, link-asana-task. If a repo opts in to use it, it will require PR authors to paste the link to the Asana task in their PR description. It will also automatically link the PR in Asana.

I think this is useful because it will require code contributors to provide the Asana task URL when they create the PR, rather than having to remember to paste the PR's URL into Asana.

@rachelauryn rachelauryn self-requested a review June 1, 2026 14:53
@rachelauryn rachelauryn merged commit 14d830e into main Jun 1, 2026
@mrmaloof mrmaloof deleted the workflows branch June 1, 2026 15:21
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.

2 participants