Add EIP: Versioning Scheme for EIPs #8034

danceratopz · 2023-12-13T09:19:25Z

This PR proposes a versioning scheme for Standards Track EIPs based on their Specifications section.

An extended rationale can be found at https://notes.ethereum.org/@danceratopz/eip-versioning.

Discussion: https://ethereum-magicians.org/t/add-eip-versioning-scheme-for-eips/17295.

eth-bot · 2023-12-13T09:20:00Z

✅ All reviewers have approved.

EIPS/eip-versioning-scheme-for-eips.md

Co-authored-by: Andrew B Coathup <28278242+abcoathup@users.noreply.github.com>

github-actions · 2023-12-14T08:16:45Z

The commit 564d13c (as a parent of 7a65704) contains errors.
Please inspect the Run Summary for details.

EIPS/eip-7577.md

gaudren · 2024-02-09T16:29:20Z

EIPS/eip-7577.md

+
+## Abstract
+
+This EIP introduces a versioning scheme for [Standards Track](./eip-1.md#eip-types) EIPs by applying semantic versioning based on changes made to the EIP's Specification section once its status has changed from `Draft` to `Review`.


Might be a good idea to provide more in depth information about semantic versioning for people who aren't familiar. You could do something similar to: https://eips.ethereum.org/EIPS/eip-5139#versioning

Thanks, I didn't know I could add an entire external document as an asset. Added in 8319b2d.

EIPS/eip-7577.md

gaudren · 2024-02-09T16:38:13Z

EIPS/eip-7577.md

+
+1. A new version number that follows the semantic versioning scheme outlined above.
+2. The date when the changes where introduced.
+3. A link to the ethereum/EIPs PR that implements the changes.


The current rules forbid links to PRs. This isn't a formatting issue, so you'll have to talk to EIP editors if you want this change.

Removed link requirement in 2a0eb65.

I think a link to the changes would be helpful to readers - I'll follow up with EIP editors to gauge interest.

gaudren · 2024-02-09T16:40:37Z

EIPS/eip-7577.md

+
+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.
+
+EIPS that have dependencies on other EIPS SHOULD include the version of the dependency in the metadata "requires" field.


Please provide more information about how this would look. EIP should include enough detail to be implementable.

91e978f:

Removed the following requirement, as it's impractical to update all downstream EIPs upon a version change:

EIPS that have dependencies on other EIPS SHOULD include the version of the dependency in the metadata "requires" field.

Modified the Specification with a suggestion for the mechanism to update an EIP version using repo tooling.

gaudren · 2024-02-09T16:44:07Z

EIPS/eip-7577.md

+
+## Rationale
+
+A semantic versioning scheme enables clearer communication within the community about EIP status and allows the impact of a change to be ascertained at first glance.


This belongs in the Motivation section.

The Motivation should be why is this proposal a good idea, where the Rationale should be why you made those specific decisions within the EIP.

Removed from Rational in 0503e84.

gaudren · 2024-02-09T16:47:27Z

EIPS/eip-7577.md

+
+A semantic versioning scheme enables clearer communication within the community about EIP status and allows the impact of a change to be ascertained at first glance.
+
+Making the version available in the EIP's metadata header additionally allows for programmatic parsing of the version number by tooling used in reference tests or by client teams. Currently, the ethereum/execution-spec-tests repository implements a rudimentary EIP version checker: EIP spec tests are required to declare the EIP's markdown file digest SHA that the test implementation was based on. The current value of the digest SHA is then polled via the Github API to verify that no changes have occurred since the test implementation. While this provides a warning to test implementers that the EIP has changed, it is clearly of limited use.


Please avoid external links (ethereum/execution-spec-tests).

Removed in 92fb8ba. The repository is still referred to, I hope that's ok?

fyi links to execution-spec-tests were recently allowed!

EIPS/eip-7577.md

Additionally remove requirement that dependent eips must include the version of the dependency.

Co-authored-by: Nikki Gaudreau <87712502+gaudren@users.noreply.github.com>

…IPs into versioning-scheme-for-eips

github-actions · 2024-05-02T00:17:51Z

There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.

shemnon · 2024-05-31T15:50:20Z

EIPS/eip-7577.md

+3. The ethereum/EIPs PR number that implements the changes.
+4. A line for each change made to the EIP's specifications that includes a short description of the change.
+
+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.


to a new "version" field

This should have higher billing. Like the first line after the RFCs. As well as the new changelog section.

A new header field `version` is added to new EIPs, as defined below, identifying the draft and/or review version of the specification. A new body section "Changelog" is added to new EIPs, as defined below, tracking the changes between draft and/or review versions of the specificaiton.

Also, we should update the EIP template to add these two new feaures as part of this EIP when it goes final.

xinbenlv · 2024-06-05T18:09:10Z

EIPS/eip-7577.md

+
+## Abstract
+
+This EIP introduces a versioning scheme for [Standards Track](./eip-1.md#eip-types) EIPs by applying [Semantic Versioning 2.0.0](../assets/eip-7577/semver.md) based on changes made to the EIP's Specification section once its status has changed from `Draft` to `Review`.


Suggested change

This EIP introduces a versioning scheme for [Standards Track](./eip-1.md#eip-types) EIPs by applying [Semantic Versioning 2.0.0](../assets/eip-7577/semver.md) based on changes made to the EIP's Specification section once its status has changed from `Draft` to `Review`.

This EIP introduces a versioning scheme for [Standards Track](./eip-1.md#eip-types) within an EIP by applying [Semantic Versioning 2.0.0](../assets/eip-7577/semver.md) based on changes made to the EIP's Specification section once its status has changed from `Draft` to `Review`.

To my best understanding this proposal is about versioning within EIP instead of across EIPs, right?

xinbenlv · 2024-06-05T18:11:23Z

EIPS/eip-7577.md

+author: danceratopz (@danceratopz), Ahmad Bitar (@smartprogrammer93)
+discussions-to: https://ethereum-magicians.org/t/add-eip-versioning-scheme-for-eips/17295
+status: Draft
+type: Meta


I wonder if this shall be Informational or Meta. I like the idea and direction. I don't think every EIP needs adopt it

xinbenlv

Editorially I think this is good enough to merge as a Draft

eth-bot

All Reviewers Have Approved; Performing Automatic Merge...

danceratopz added 7 commits December 13, 2023 10:13

Initial versioning scheme draft with incomplete case study

8ac6e54

Improvements and add a versioning + testing toolchain flowchart

4dbe8bb

More improvements

56e1f34

More precise phrasing for abstract

133ad54

Remove mermaid flow diagram and other clean-up

3cab575

First version fo the 4788 versioning vase study

3795273

Clean-up and remove template comments

4a85fc0

danceratopz requested a review from eth-bot as a code owner December 13, 2023 09:19

github-actions bot added c-new Creates a brand new proposal s-draft This EIP is a Draft t-meta labels Dec 13, 2023

eth-bot added e-consensus Waiting on editor consensus e-review Waiting on editor to review labels Dec 13, 2023

github-actions bot added the w-ci Waiting on CI to pass label Dec 13, 2023

Add eth magicians discussions link

a2b6c43

danceratopz mentioned this pull request Dec 13, 2023

EIPIP Meeting 96 ethcatherders/EIPIP#300

Closed

11 tasks

smartprogrammer93 added 2 commits December 13, 2023 20:02

Update eip-versioning-scheme-for-eips.md

1d5a31a

remove not needed sections

c8b32fa

github-actions bot removed the w-ci Waiting on CI to pass label Dec 13, 2023

add eip to be assigned so a suggestion can easily be made

bcc524d

github-actions bot added the w-ci Waiting on CI to pass label Dec 13, 2023

abcoathup reviewed Dec 13, 2023

View reviewed changes

EIPS/eip-versioning-scheme-for-eips.md Outdated Show resolved Hide resolved

danceratopz and others added 2 commits December 14, 2023 09:09

Add assigned EIP number to header.

564d13c

Co-authored-by: Andrew B Coathup <28278242+abcoathup@users.noreply.github.com>

Rename eip with assigned number

00a28b6

Remove links to github.

2a52b0e

github-actions bot removed the w-ci Waiting on CI to pass label Dec 14, 2023

zijwij-byxmyq-1wIxre approved these changes Dec 19, 2023

View reviewed changes

Merge branch 'master' into versioning-scheme-for-eips

acae175

poojaranjan mentioned this pull request Feb 6, 2024

EIP Editing Office Hour Meeting 31 ethcatherders/EIPIP#307

Closed

21 tasks

gaudren reviewed Feb 9, 2024

View reviewed changes

danceratopz and others added 8 commits March 13, 2024 12:51

remove requirement to include a github pr link in changelog entries

2a0eb65

remove motivational content from rationale section

0503e84

add sem ver 2.0.0 doc to assets and link to it from eip text

8319b2d

simplify explanation of minor version

02769ff

specify repo tooling mechanism to assist automatic version bumping

91e978f

Additionally remove requirement that dependent eips must include the version of the dependency.

Apply suggestions from code review

494400f

Co-authored-by: Nikki Gaudreau <87712502+gaudren@users.noreply.github.com>

Merge branch 'versioning-scheme-for-eips' of github.com:danceratopz/E…

7fae3bb

…IPs into versioning-scheme-for-eips

remove link to ethereum/execution-spec-tests

92fb8ba

github-actions bot added the w-stale Waiting on activity label May 2, 2024

poojaranjan mentioned this pull request May 8, 2024

EIP Editing Office Hour Meeting 37 ethcatherders/EIPIP#335

Closed

19 tasks

poojaranjan mentioned this pull request May 28, 2024

EIP Editing Office Hour Meeting 38 ethcatherders/EIPIP#338

Closed

13 tasks

shemnon reviewed May 31, 2024

View reviewed changes

github-actions bot removed the w-stale Waiting on activity label Jun 1, 2024

poojaranjan mentioned this pull request Jun 5, 2024

EIPIP Meeting 105 ethcatherders/EIPIP#337

Closed

6 tasks

xinbenlv reviewed Jun 5, 2024

View reviewed changes

xinbenlv approved these changes Jun 5, 2024

View reviewed changes

eth-bot enabled auto-merge (squash) June 5, 2024 18:12

eth-bot approved these changes Jun 5, 2024

View reviewed changes

eth-bot merged commit 7a1265c into ethereum:master Jun 5, 2024
19 checks passed

danceratopz mentioned this pull request Jun 5, 2024

Improve Specs Initial Summary & Decouple EIP Status and Version danceratopz/EIPs#1

Open

Mortiemi mentioned this pull request Aug 29, 2024

>to a new "version" field coinbase/salus#882

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add EIP: Versioning Scheme for EIPs #8034

Add EIP: Versioning Scheme for EIPs #8034

danceratopz commented Dec 13, 2023 •

edited

Loading

eth-bot commented Dec 13, 2023 •

edited

Loading

github-actions bot commented Dec 14, 2023

gaudren Feb 9, 2024

danceratopz Mar 14, 2024

gaudren Feb 9, 2024

danceratopz Mar 14, 2024

gaudren Feb 9, 2024

danceratopz Mar 14, 2024

gaudren Feb 9, 2024

danceratopz Mar 14, 2024

gaudren Feb 9, 2024

danceratopz Mar 14, 2024

lightclient Mar 14, 2024

github-actions bot commented May 2, 2024

shemnon May 31, 2024

xinbenlv Jun 5, 2024 •

edited

Loading

xinbenlv Jun 5, 2024

xinbenlv left a comment

eth-bot left a comment


		## Abstract

		This EIP introduces a versioning scheme for [Standards Track](./eip-1.md#eip-types) EIPs by applying semantic versioning based on changes made to the EIP's Specification section once its status has changed from `Draft` to `Review`.


		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.

		EIPS that have dependencies on other EIPS SHOULD include the version of the dependency in the metadata "requires" field.


		## Rationale

		A semantic versioning scheme enables clearer communication within the community about EIP status and allows the impact of a change to be ascertained at first glance.


		A semantic versioning scheme enables clearer communication within the community about EIP status and allows the impact of a change to be ascertained at first glance.

		Making the version available in the EIP's metadata header additionally allows for programmatic parsing of the version number by tooling used in reference tests or by client teams. Currently, the ethereum/execution-spec-tests repository implements a rudimentary EIP version checker: EIP spec tests are required to declare the EIP's markdown file digest SHA that the test implementation was based on. The current value of the digest SHA is then polled via the Github API to verify that no changes have occurred since the test implementation. While this provides a warning to test implementers that the EIP has changed, it is clearly of limited use.

Add EIP: Versioning Scheme for EIPs #8034

Add EIP: Versioning Scheme for EIPs #8034

Conversation

danceratopz commented Dec 13, 2023 • edited Loading

eth-bot commented Dec 13, 2023 • edited Loading

github-actions bot commented Dec 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 2, 2024

Choose a reason for hiding this comment

xinbenlv Jun 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xinbenlv left a comment

Choose a reason for hiding this comment

eth-bot left a comment

Choose a reason for hiding this comment

danceratopz commented Dec 13, 2023 •

edited

Loading

eth-bot commented Dec 13, 2023 •

edited

Loading

xinbenlv Jun 5, 2024 •

edited

Loading