Repository files navigation

Defaultcommunity health filesfor ProseGrinder.

Workflows are designed based onConventional Commits.

In general, workflows should follow this pattern:

1. Default (typically main) is protected and only updated via PRs.
2. Every PR should pass linting and tests, found in the language’s CI workflow
3. On merge, the release workflow should

The following are reusable workflows per language.

Conventional commits will drive versioning via the Python implementation ofcommitizen.

• Poetry Lint: Runspylint andblack.
• Poetry Test: Runspytest tests.
• Poetry CI:
  • Invoke onpush to PR branch.
  • MUST pass in order to merge PR.
  • Combines Lint and Test into a single workflow.
• Poetry Release
  • Invoke onpush tomain, typically via PR merge.
  • Bumps the project version and generates a changelog via Commitizen, based onConventional Commits.
  • Tags the project and pushes changes to main.
  • Creates a GitHub release based on the tag and the changelog created byCommitizen.
• Poetry Publish
  • Invoke ontag, typically via Poetry Release.
  • Builds the project.
  • Optionally publishes to PyPi test. See workflow for details.
  • Publish to PyPi.