Skip to content

Commit 00a111e

Browse files
authored
feat: Add conventional commits check and release please (#256)
1 parent af14640 commit 00a111e

File tree

5 files changed

+67
-0
lines changed

5 files changed

+67
-0
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Lint PR Title
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- reopened
9+
10+
jobs:
11+
lint-pr-title:
12+
permissions:
13+
pull-requests: read
14+
uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/conventional-commits.yml@conventional-commits-v1.0.1

.github/workflows/release.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: release-please
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: write
10+
issues: write
11+
pull-requests: write
12+
13+
jobs:
14+
release-please:
15+
uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/release-please.yml@release-please-v2.1.0
16+
secrets: inherit

.release-please-manifest.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "6.0.0"
3+
}

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,12 @@ Additionally, the migration process will look for some smart contracts before de
7878

7979
# Development
8080

81+
This project uses trunk-based development workflow with automatic release management. It means that:
82+
- Only squash merge commits are accepted.
83+
- When merging a PR, its title is used as the commit message.
84+
- A check is added to enforce using the correct format for PR titles (feat:..., fix:..., ...).
85+
- Release please is used to manage Github releases.
86+
8187
## Build
8288

8389
The PoCo smart contracts are in the `contracts/` folder. Json artifacts, containing the contracts bytecode and ABI can be found in the `artifacts/` folder. In case you need to regenerate them, you can use the following command:

release-please-config.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"packages": {
3+
".": {
4+
"release-type": "node",
5+
"changelog-path": "CHANGELOG.md",
6+
"include-v-in-tag": true
7+
}
8+
},
9+
"changelog-sections": [
10+
{ "type": "feat", "section": "🚀 Added", "hidden": false },
11+
{ "type": "change", "section": "✍️ Changed", "hidden": false },
12+
{ "type": "deprecate", "section": "✍️ Changed", "hidden": false },
13+
{ "type": "remove", "section": "✍️ Changed", "hidden": false },
14+
{ "type": "fix", "section": "✍️ Changed", "hidden": false },
15+
{ "type": "revert", "section": "✍️ Changed", "hidden": false },
16+
{ "type": "security", "section": "✍️ Changed", "hidden": false },
17+
{ "type": "perf", "section": "✍️ Changed", "hidden": false },
18+
{ "type": "refactor", "section": "✍️ Changed", "hidden": false },
19+
{ "type": "style", "section": "✍️ Changed", "hidden": false },
20+
{ "type": "build", "section": "📋 Misc", "hidden": false },
21+
{ "type": "chore", "section": "📋 Misc", "hidden": false },
22+
{ "type": "deps", "section": "📋 Misc", "hidden": true },
23+
{ "type": "ci", "section": "📋 Misc", "hidden": true },
24+
{ "type": "test", "section": "📋 Misc", "hidden": false },
25+
{ "type": "docs", "section": "📋 Misc", "hidden": true }
26+
],
27+
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
28+
}

0 commit comments

Comments
 (0)