Skip to content

Commit d27a489

Browse files
authored
Update README.MD
1 parent 250bf84 commit d27a489

1 file changed

Lines changed: 61 additions & 2 deletions

File tree

README.MD

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
cat > ~/tips-ecosystem/README.md << 'EOF'
21
# Tips Ecosystem L1
32

43
Decentralized Tipping Blockchain - A complete ecosystem for content creator tips and rewards.
@@ -23,4 +22,64 @@ npm install
2322
# Copy environment file
2423
cp .env.example .env
2524

26-
# Edit .env with your private key and RPC URLs
25+
# Edit .env with your private key and RPC URLs
26+
27+
28+
---
29+
Here’s a **CI/CD section in English** you can drop straight into your `README.md`. It explains the pipelines clearly for developers and contributors:
30+
31+
---
32+
33+
## ⚙️ CI/CD Pipelines
34+
35+
This repository uses **GitHub Actions** to automate testing, deployment, and release workflows. All pipelines are defined under `.github/workflows/`.
36+
37+
### 🔹 CI Pipeline (`ci.yml`)
38+
- Trigger: every **push** and **pull request**
39+
- Tasks:
40+
- Lint (ESLint, Prettier)
41+
- Solidity lint (Solhint)
42+
- Compile contracts (Hardhat)
43+
- Run tests
44+
- Gas report
45+
- Contract size check
46+
47+
### 🔹 Staging Pipeline (`staging.yml`)
48+
- Trigger: push to **develop** branch
49+
- Tasks:
50+
- Compile + Test
51+
- Deploy contracts → **Sepolia Testnet**
52+
- Verify contracts on Etherscan/Blockscout
53+
54+
### 🔹 Deploy Pipeline (`deploy.yml`)
55+
- Trigger: merge into **main** branch
56+
- Tasks:
57+
- Build Explorer
58+
- Build Dashboard
59+
- Upload build artifacts
60+
61+
### 🔹 Release Pipeline (`release.yml`)
62+
- Trigger: new **tag** (`vX.Y.Z`) pushed
63+
- Tasks:
64+
- Compile + Test
65+
- Coverage report
66+
- Gas report
67+
- Contract size check
68+
- Upload coverage artifacts
69+
70+
### 🔹 Production Pipeline (`production.yml`)
71+
- Trigger: merge into **main** branch
72+
- Tasks:
73+
- Compile + Test
74+
- Deploy contracts → **Mainnet**
75+
- Verify contracts on Etherscan/Blockscout
76+
- Upload deployment logs
77+
78+
---
79+
80+
## 🚀 Workflow Summary
81+
- **Development stage** → push to `develop` → automatic testnet deploy
82+
- **Production stage** → merge to `main` → automatic mainnet deploy
83+
- **Release stage** → push a tag (`v1.0.0`) → automatic audit reports
84+
85+
---

0 commit comments

Comments
 (0)