Skip to content

Commit a3e1a03

Browse files
committed
Update README
1 parent 6e9e19e commit a3e1a03

1 file changed

Lines changed: 42 additions & 1 deletion

File tree

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ In short: EOAs can temporarily behave like programmable accounts through delegat
2929

3030
```text
3131
.
32+
├── .github/
33+
│ └── workflows/
34+
│ ├── ci.yml
35+
│ ├── release.yml
36+
│ └── vulncheck.yml
3237
├── docs/
3338
│ └── IMPLEMENTATION_NOTES.md
3439
├── examples/
@@ -55,6 +60,9 @@ In short: EOAs can temporarily behave like programmable accounts through delegat
5560
│ ├── client.go
5661
│ ├── client_test.go
5762
│ └── types.go
63+
├── scripts/
64+
│ └── build-release.sh
65+
├── Makefile
5866
├── go.mod
5967
└── README.md
6068
```
@@ -102,6 +110,39 @@ go run ./examples/transaction-batching
102110
go run ./examples/send-userop
103111
```
104112

113+
### 4. Run full local CI
114+
115+
```bash
116+
make ci
117+
```
118+
119+
## CI/CD
120+
121+
This project includes three GitHub Actions workflows:
122+
123+
- **CI** (`.github/workflows/ci.yml`)
124+
- Triggered on pull requests and pushes to `main` / `master`
125+
- Runs format checks, module tidy check, vet, race tests, build, and example runs
126+
- **Release CD** (`.github/workflows/release.yml`)
127+
- Triggered on tags matching `v*` (for example `v0.1.0`)
128+
- Builds cross-platform example binaries and publishes release artifacts
129+
- **Vulnerability Scan** (`.github/workflows/vulncheck.yml`)
130+
- Weekly scheduled `govulncheck` + manual run support
131+
132+
### Release process
133+
134+
1. Push a semantic tag:
135+
136+
```bash
137+
git tag v0.1.0
138+
git push origin v0.1.0
139+
```
140+
141+
2. The release workflow will:
142+
- Build artifacts for `linux`, `darwin`, and `windows`
143+
- Generate `dist/checksums.txt`
144+
- Publish assets to a GitHub Release
145+
105146
## Example Walkthroughs
106147

107148
### A) Basic Authorization
@@ -167,4 +208,4 @@ Read more in [`docs/IMPLEMENTATION_NOTES.md`](docs/IMPLEMENTATION_NOTES.md).
167208
- EIP-7702: [https://eips.ethereum.org/EIPS/eip-7702](https://eips.ethereum.org/EIPS/eip-7702)
168209
- Ethereum Magicians thread: [https://ethereum-magicians.org/t/eip-set-eoa-account-code-for-one-transaction/19923](https://ethereum-magicians.org/t/eip-set-eoa-account-code-for-one-transaction/19923)
169210
- Proxy pattern gist: [https://gist.github.com/lightclient/7742e84fde4962f32928c6177eda7523](https://gist.github.com/lightclient/7742e84fde4962f32928c6177eda7523)
170-
- Best practices draft: [https://hackmd.io/@rimeissner/eip7702-best-practices](https://hackmd.io/@rimeissner/eip7702-best-practices)
211+
- Best practices draft: [https://hackmd.io/@rimeissner/eip7702-best-practices](https://hackmd.io/@rimeissner/eip7702-best-practices)

0 commit comments

Comments
 (0)