Skip to main content

Release Process

A release should be reproducible, tested, and documented. Treat the package published to PyPI as the public source of truth for released versions.

Before publishing​

  1. Run the full test suite.
  2. Check platform-sensitive behavior and known regressions.
  3. Update documentation for changed commands or behavior.
  4. Review the changelog and package metadata.
  5. Build and inspect the distribution artifacts.
  6. Verify the version number and release files before uploading.

Versioning​

FOLDR uses semantic versioning in the MAJOR.MINOR.PATCH form:

  • MAJOR for incompatible changes;
  • MINOR for backward-compatible functionality;
  • PATCH for backward-compatible fixes.

Use the versioning policy consistently with the current package's published version line.

After publishing​

  • Install the published package into a clean environment.
  • Verify the version and critical commands.
  • Confirm that the PyPI project page and documentation point to one another.
  • Record the release notes for the version that was actually published.