Skip to content

chore: add per-package changelog files #2036

@danceratopz

Description

@danceratopz

Status Quo: We currently have a single docs/CHANGELOG.md, which is a pre-weld leftover from execution-spec-tests.

Proposal: Add separate changelog files for each area/package in the repository:

  • src/ethereum/CHANGELOG.md - ethereum package changes.
  • packages/testing/CHANGELOG.md - testing workspace changes (not essential now, forward thinking).
  • tests/CHANGELOG.md:
    • extremely helpful for test releases and client devs.
    • TBD: Should this only list changes that change test fixtures? i.e., skip refactors, feat=new test, fix=change in test behavior.

Motivation

The test changelog is essential to inform client devs which tests have changed, which new tests are included, and what to expect from release to release.

Drawback

The tests/ changelog will likely have frequent merge conflicts, especially when dealing with branches that create test releases (e.g., the devnets/amsterdam/2 branch). This is largely unavoidable given the nature of concurrent test development.

Alternative Approaches

We could automatically generate a changelog based on commits.

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-choreCategory: choreS-needs-discussionStatus: needs discussionstaleThe Issue/PR has not had any activity for 60 days. PRs will be automatically closed.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions