Skip to content

Keep LibreSign release history canonical in the app repository #86

Description

@vitormattos

Parent: #70
Depends on: #73, #81, #84, #88
Related: LibreSign/documentation#97

Goal

Keep LibreSign release history canonical in the application repository and document the release process without duplicating changelog content into LibreSign/documentation.

Source of truth

The only changelog / release-history source is:

LibreSign/libresign/docs/changelogs/changelog-<major>.md

Package-root CHANGELOG.md and GitHub Release notes are derived presentations of the same released section.

LibreSign/documentation documents the process, recovery procedure and where the canonical changelog lives. It must not maintain generated or manually synchronized copies of the changelog.

Repository boundary

  • LibreSign/libresign owns per-major changelog files and released history.
  • LibreCodeCoop/release-tool owns release contracts and policy.
  • LibreCodeCoop/github-workflows owns orchestration only.
  • LibreSign/documentation owns human documentation of the process, not release-history data.

The app package must not depend on the documentation repository.

Acceptance criteria

  • no changelog synchronization into LibreSign/documentation;
  • no duplicated generated release-history pages in LibreSign/documentation;
  • documentation clearly points maintainers to the canonical per-major changelog in LibreSign/libresign;
  • package-root CHANGELOG.md and GitHub Release notes remain derived from the released changelog section;
  • security-mode releases do not expose advisory-private content through documentation;
  • Document the complete LibreSign release lifecycle and manual path LibreSign/documentation#97 reflects this single-source model.

Definition of done

  • the previously introduced documentation history synchronization is removed;
  • LibreSign/documentation contains process documentation only, with no copied release-history dataset;
  • the canonical changelog remains in LibreSign/libresign only;
  • documentation explains the mapping from canonical changelog to package and GitHub Release presentations;
  • Document the complete LibreSign release lifecycle and manual path LibreSign/documentation#97 reflects the implemented process and source-of-truth boundary.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions