chore: Sunset towncrier release notes

ethereum · Oct 11, 2023 · 145abea · 145abea
1 parent c443ee8
commit 145abea
Show file tree

Hide file tree

Showing 207 changed files with 17 additions and 628 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -128,9 +128,6 @@ jobs:
         steps:
             - checkout
             - install-depends
-            - run:
-                name: Validate release notes entry
-                command: ./newsfragments/validate_files.py
             - run:
                 name: Run rustfmt
                 command: cargo fmt --all -- --check

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,4 +5,4 @@
 ### To-Do
 
 [//]: # (Stay ahead of things, add list items here!)
-- [ ] Clean up commit history
+- [ ] Clean up commit history and use conventional commits
diff --git a/Makefile b/Makefile
@@ -15,15 +15,6 @@ lint-unstable:
 		cargo fmt --all -- --check
 		RUSTFLAGS="-W unused_crate_dependencies" cargo build
 
-notes:
-		towncrier --yes --version $(version)
-		git commit -m "Compile release notes"
-
-release:
-		# First run `make notes version=<version>` before this
-		./newsfragments/validate_files.py is-empty
-		cargo release $(version) --all --execute
-
 create-docker-image:
 		docker build -t ethpm/trin:latest -t ethpm/trin:$(version) -f ./Dockerfile .
 

diff --git a/book/src/developers/contributing/git/commits.md b/book/src/developers/contributing/git/commits.md
@@ -18,16 +18,22 @@ written.  Once things are complete, you can `git reset master` to unstage all
 of the changes you've made, and then re-commit them in small chunks using `git
 add -p`.
 
-## Commit Messages
+### Commit Messages
 
-We don't care much about commit messages other than that they be sufficiently
-descriptive of what is being done in the commit.
+We use conventional commits for our commit messages.  This means that your
+commit messages should be of the form:
 
-The *correct* phrasing of a commit message.
+```text
+<type>[optional scope]: <description>
+```
 
-- `fix bug #1234` (correct)
-- `fixes bug #1234` (wrong)
-- `fixing bug #1234` (wrong)
+To learn more about conventional commits please check out the [conventional commits website](https://www.conventionalcommits.org/en/v1.0.0/).
+
+Examples:
+
+- `fix: Update metrics strategy to support multiple subnetworks`
+- `refactor(light-client): Refactor light-client crate to use `ethportal-api` consensus types`
+- `feat(rpc): Return header to eth_getBlockByHash`
 
 One way to test whether you have it right is to complete the following sentence.
 

diff --git a/book/src/developers/contributing/git/release_notes.md b/book/src/developers/contributing/git/release_notes.md
@@ -1,3 +1,5 @@
 # Release notes
 
-Every pull request should include a Newsfragment markdown file to describe the contents of the pull request. These files are automatically formatted & collected upon each new release. The format for creating a Newsfragment file can be found in the [README](../newsfragments/README.md).
+We use conventional commits to generate release notes.
+
+Check the [commits guide](commits.md) for more information on how to write commit messages.
diff --git a/book/src/developers/quick_setup.md b/book/src/developers/quick_setup.md
@@ -4,8 +4,6 @@ This is a single page that aims to cover everything required to get Trin running
 
 **Trin is currently in unstable alpha, and should not be used in production. If you run into any bugs while using Trin, please file an Issue!**
 
-**Check out the `./newsfragments` directory to see the latest changes.**
-
 ## Building on Debian Based Systems
 
 ### Prerequisites

diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/release_notes.md b/docs/release_notes.md
diff --git a/newsfragments/228.added.md b/newsfragments/228.added.md
diff --git a/newsfragments/241.added.md b/newsfragments/241.added.md
diff --git a/newsfragments/248.added.md b/newsfragments/248.added.md
diff --git a/newsfragments/248.changed.md b/newsfragments/248.changed.md
diff --git a/newsfragments/250.fixed.md b/newsfragments/250.fixed.md
diff --git a/newsfragments/252.doc.md b/newsfragments/252.doc.md
diff --git a/newsfragments/256.added.md b/newsfragments/256.added.md
diff --git a/newsfragments/258.added.md b/newsfragments/258.added.md
diff --git a/newsfragments/261.added.md b/newsfragments/261.added.md
diff --git a/newsfragments/265.added.md b/newsfragments/265.added.md
diff --git a/newsfragments/266.removed.md b/newsfragments/266.removed.md
diff --git a/newsfragments/269.doc.md b/newsfragments/269.doc.md
diff --git a/newsfragments/270.added.md b/newsfragments/270.added.md
diff --git a/newsfragments/271.added.md b/newsfragments/271.added.md
diff --git a/newsfragments/275.added.md b/newsfragments/275.added.md
diff --git a/newsfragments/276.fixed.md b/newsfragments/276.fixed.md
diff --git a/newsfragments/278.fixed.md b/newsfragments/278.fixed.md
diff --git a/newsfragments/282.added.md b/newsfragments/282.added.md
diff --git a/newsfragments/283.added.md b/newsfragments/283.added.md
diff --git a/newsfragments/286.fixed.md b/newsfragments/286.fixed.md
diff --git a/newsfragments/288.fixed.md b/newsfragments/288.fixed.md
diff --git a/newsfragments/292.added.md b/newsfragments/292.added.md
diff --git a/newsfragments/293.fixed.md b/newsfragments/293.fixed.md
diff --git a/newsfragments/294.fixed.md b/newsfragments/294.fixed.md
diff --git a/newsfragments/295.fixed.md b/newsfragments/295.fixed.md