Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 1dadad2

Browse files
authoredMay 29, 2025··
chore: add instruction of generating changelog from last release (#1405)
**Motivation:** add instruction of how to generate changelog from last release **Modifications:** add instruction of how to generate changelog from last release **Result:** add instruction of how to generate changelog from last release
1 parent a355b86 commit 1dadad2

File tree

1 file changed

+45
-4
lines changed

1 file changed

+45
-4
lines changed
 

‎CHANGELOG/CHANGELOG-template.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,50 @@ github handle of release manager
3535

3636
## Changelog
3737

38-
Copy the one that's auto generated from github by default to here, and submit PR for review
38+
To generate a changelog of commits added since the last release using Git on
39+
the command line, follow these steps:
3940

41+
1. Identify the last release tag
4042

41-
- merged PRs in diff from last release
42-
- contributors
43-
- etc
43+
First, list your tags (assuming you use Git tags for releases):
44+
45+
```
46+
git tag --sort=-creatordate
47+
```
48+
49+
This shows your most recent tags at the top. Let's say the last release tag is `v1.4.2`
50+
51+
52+
2. Generate the changelog
53+
54+
Now, use the following command to list the commits since that tag, and auto generate github PR link if there's any
55+
56+
```
57+
git log v1.4.2..HEAD --pretty=format:"%s" --no-merges | \
58+
sed -E 's/^(.*)\(#([0-9]+)\)$/- \1[PR #\2](https:\/\/github.com\/layr-labs\/eigenlayer-contracts\/pull\/\2)/' | \
59+
sed -E '/\[PR #[0-9]+\]/! s/^(.*)$/- \1/'
60+
```
61+
62+
This will show:
63+
64+
- Only commits since v1.4.2 up to the current HEAD
65+
- One-line commit messages (%s) with the author name (%an)
66+
67+
68+
An example output is:
69+
70+
```
71+
- ci: add explicit permissions to workflows to mitigate security concerns [PR #1392](https://github.com/layr-labs/eigenlayer-contracts/pull/1392)
72+
- ci: remove branch constraint for foundry coverage job
73+
- docs: add release managers to changelogs
74+
- docs: add templates for changelog and release notes [PR #1382](https://github.com/layr-labs/eigenlayer-contracts/pull/1382)
75+
- docs: add doc for steps to write deploy scripts [PR #1380](https://github.com/layr-labs/eigenlayer-contracts/pull/1380)
76+
- ci: add testnet envs sepolia and hoodi to validate-deployment-scripts [PR #1378](https://github.com/layr-labs/eigenlayer-contracts/pull/1378)
77+
- docs: update MAINTENANCE to include practices of merging multiple release-dev branches
78+
- docs: updating readme for dead links, readability, new language, and more [PR #1377](https://github.com/layr-labs/eigenlayer-contracts/pull/1377)
79+
...
80+
```
81+
82+
3. Commit the Changelog
83+
84+
Copy the output and add here with a commit, then proceed to cut the release from the commit.

0 commit comments

Comments
 (0)
Please sign in to comment.