Skip to content

RELEASE.md

Latest commit

 

History

History
74 lines (56 loc) · 4.05 KB

RELEASE.md

File metadata and controls

74 lines (56 loc) · 4.05 KB

Release process

Creating a new version (e.g. v1.5.0)

  1. Ensure everything is ready

    • CHANGELOG.md has the target version (e.g. [1.5.0]) with date and full entry; [Unreleased] is at the top and empty or updated for the next cycle.
    • UPGRADING.md has a section “Upgrading to X.Y.Z” with what’s new, breaking changes (if any), and upgrade steps.
    • Tests pass: make test or composer test.
    • Code style: make cs-check or composer cs-check.
    • Assets built: make assets (so src/Resources/public/js/pdf-signable.js is up to date).
    • Translations: make validate-translations passes.

  2. Commit and push any last changes to your default branch (e.g. main or master):

    git add -A
git commit -m "Prepare v1.5.0 release"
git push origin HEAD

  3. Create and push the tag

    git tag -a v1.5.0 -m "Release v1.5.0"
git push origin v1.5.0

  4. GitHub Actions (if .github/workflows/release.yml is configured) will create the GitHub Release from the tag.

  5. Packagist (if the package is registered) will pick up the new tag; users can then composer require nowo-tech/pdf-signable-bundle. See Registering on Packagist below if the package is not yet on Packagist.

Registering on Packagist

For the bundle to be discoverable and installable via composer require nowo-tech/pdf-signable-bundle without adding a custom repository, it must be registered on Packagist.

  1. Create an account at packagist.org (or log in with GitHub).
  2. Submit the package: go to Submit and enter the repository URL:
    • https://github.com/nowo-tech/pdfSignableBundle
    • or https://github.com/nowo-tech/pdfSignableBundle.git
  3. Packagist will fetch composer.json from the root of the repository. Ensure:
    • name is nowo-tech/pdf-signable-bundle (lowercase, hyphen-separated).
    • description is set (required for publication).
    • There is no version field in composer.json (Packagist infers versions from Git tags, e.g. v1.0.0, v2.0.2).
  4. After submission, Packagist will auto-update when you push new tags (or you can trigger an update from the package page).
  5. Validate before submitting: run composer validate in the bundle root (and fix any errors).

Once registered, the package appears in search, and users can install it with composer require nowo-tech/pdf-signable-bundle without any extra repository configuration.

After releasing

  • Keep ## [Unreleased] at the top of CHANGELOG.md for the next version; add new changes there.
  • Optionally bump version in composer.json to the next dev (e.g. 1.5.0-dev) for development.

Ready for v2.0.4 (2026-03-02)

  • CHANGELOG: [2.0.4] with date; [Unreleased] at top; links updated.
  • UPGRADING: “Upgrading to 2.0.4" with release date and upgrade steps.
  • RELEASE: this checklist for v2.0.4.
  • Run locally: make test and make cs-check.
  • Run locally: make assets (bundle JS + worker built).
  • Run locally: make validate-translations.
  • Run locally: composer validate --strict (root composer.json).
  • Commit and push: git add -A && git commit -m "Prepare v2.0.4 release" && git push origin HEAD
  • Create and push tag: git tag -a v2.0.4 -m "Release v2.0.4" then git push origin v2.0.4

Next release (e.g. v2.0.5)

  • CHANGELOG: Move [Unreleased] entries into [X.Y.Z] with date; add new empty [Unreleased] at top; update version links at bottom.
  • UPGRADING: Add section "Upgrading to X.Y.Z" with release date, what's new, breaking changes (if any), and upgrade steps; update version compatibility table.
  • RELEASE: Replace "Next release" checklist with "Ready for vX.Y.Z" and complete the steps above.
  • Run make test, make cs-check, make assets, make validate-translations.
  • Tag and push; create GitHub Release if workflow is configured.