Skip to content

Commit

Permalink
specify repo tooling mechanism to assist automatic version bumping
Browse files Browse the repository at this point in the history
Additionally remove requirement that dependent eips must include the version of the dependency.
  • Loading branch information
danceratopz committed Mar 14, 2024
1 parent 02769ff commit 91e978f
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions EIPS/eip-7577.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The EIP versioning scheme MUST apply the following semantic versioning scheme of

Before the EIP has moved out of Draft status and is being versioned, the version number MUST initially have `MAJOR` version `0`.

For every change made to an EIP via a PR made to ethereum/EIPs, the PR author MUST add a new entry to the CHANGELOG section of the EIP that outlines the changes made within the PR. This CHANGELOG entry MUST include the following:
For every change made to an EIP via a PR made to ethereum/EIPs, a new entry MUST be added to the CHANGELOG section of the EIP that outlines the changes made within the PR. This CHANGELOG entry MUST include the following:

1. A new version number that follows the semantic versioning scheme outlined above.
2. The date when the changes where introduced.
Expand All @@ -40,9 +40,12 @@ For every change made to an EIP via a PR made to ethereum/EIPs, the PR author MU

Additionally, the new version MUST be added to the metadata header of the EIP's markdown file (to a new "version" field), so that it may be easily parsed.

Tooling SHOULD be added to the ethereum/EIPs repository that checks that the CHANGELOG is updated and that the version number in the metadata header matches the latest version number in the CHANGELOG.
Tooling MUST be added to the ethereum/EIPs repository to help EIP authors apply the versioning scheme. This tooling SHOULD automatically:

EIPS that have dependencies on other EIPS SHOULD include the version of the dependency in the metadata "requires" field.
1. Update the EIP version in the metadata header of the EIP's markdown file. If the EIP's status is changed from "Draft" to "Review", the version MUST be updated to `1.0.0`.
2. Add a new CHANGELOG entry based on the EIP Version and the PR's title.

To allow the tooling to make these changes, the EIP author MUST indicate the scope of change in one of the commit messages pushed to the PR's branch. The scope is indicated by starting a commit message with ("`[Mm]ajor:`", "`[Mm]inor:`", or "`[Pp]atch`"). Multiple commit messages may contain scopes; in this case, the most severe scope change will be applied. If no scope can be detected in any of the commit messages, merging of the PR is blocked until such a commit message is pushed to the PR.

## Rationale

Expand Down

0 comments on commit 91e978f

Please sign in to comment.