Skip to content

Commit 7480d33

Browse files
style: format project
1 parent 1bbe69b commit 7480d33

24 files changed

Lines changed: 241 additions & 261 deletions

File tree

‎.github/workflows/docker-build-cloud.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ on:
2828
default: "."
2929
type: string
3030
build-args:
31-
description: "Docker build arguments (multiline format: KEY1=value1\nKEY2=value2)"
31+
description:
32+
"Docker build arguments (multiline format: KEY1=value1\nKEY2=value2)"
3233
default: ""
3334
type: string
3435
attest:

‎.github/workflows/docker-build.yml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ on:
44
workflow_call:
55
inputs:
66
build-args:
7-
description: "Docker build arguments (multiline format: KEY1=value1\nKEY2=value2)"
7+
description:
8+
"Docker build arguments (multiline format: KEY1=value1\nKEY2=value2)"
89
default: ""
910
type: string
1011
image-name:
@@ -149,8 +150,8 @@ jobs:
149150
context: ${{ inputs.context }}
150151
file: ${{ inputs.dockerfile }}
151152
platforms: ${{ inputs.platform }}
152-
load: true # Make the image available on runner
153-
push: false # Don't push yet, wait for security checks
153+
load: true # Make the image available on runner
154+
push: false # Don't push yet, wait for security checks
154155
tags: ${{ inputs.image-name }}:${{ inputs.image-tag }}
155156

156157
- name: Run Trivy vulnerability scanner

‎.github/workflows/docker-promote.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,8 @@ jobs:
214214
image-ref: ${{ env.IMAGE }}@${{ steps.tested.outputs.digest }}
215215
format: table
216216
ignore-unfixed: true
217-
vuln-type: 'os,library'
218-
severity: 'CRITICAL,HIGH'
217+
vuln-type: "os,library"
218+
severity: "CRITICAL,HIGH"
219219
hide-progress: true
220220
exit-code: 1
221221
# same scanner version as the CI build, so a finding here means the

‎.github/workflows/propose-safe-multisig-tx.yml‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,45 @@
1-
name: 'Propose Safe Multisig Transaction'
1+
name: "Propose Safe Multisig Transaction"
22
on:
33
workflow_call:
44
inputs:
55
safe-address:
6-
description: 'Address of the Safe contract'
6+
description: "Address of the Safe contract"
77
required: true
88
type: string
99
transaction-to:
10-
description: 'Target address of the transaction'
10+
description: "Target address of the transaction"
1111
required: true
1212
type: string
1313
transaction-value:
14-
description: 'Value to send in the transaction (in wei, default: 0)'
14+
description: "Value to send in the transaction (in wei, default: 0)"
1515
required: false
16-
default: '0'
16+
default: "0"
1717
type: string
1818
transaction-data:
19-
description: 'Transaction data/calldata'
19+
description: "Transaction data/calldata"
2020
required: true
2121
type: string
2222
dry-run:
23-
description: 'If true, validate and prepare the transaction without proposing it'
23+
description: "If true, validate and prepare the transaction without proposing it"
2424
required: false
2525
default: false
2626
type: boolean
2727
secrets:
2828
rpc-url:
29-
description: 'RPC URL for the blockchain network'
29+
description: "RPC URL for the blockchain network"
3030
required: true
3131
safe-proposer-private-key:
32-
description: 'Private key of the proposer wallet'
32+
description: "Private key of the proposer wallet"
3333
required: true
3434
safe-api-key:
35-
description: 'Safe API key for transaction service'
35+
description: "Safe API key for transaction service"
3636
required: true
3737
outputs:
3838
tx-hash:
39-
description: 'Hash of the Safe transaction'
39+
description: "Hash of the Safe transaction"
4040
value: ${{ jobs.propose-transaction.outputs.tx-hash }}
4141
tx-details:
42-
description: 'Created transaction details'
42+
description: "Created transaction details"
4343
value: ${{ jobs.propose-transaction.outputs.tx-details }}
4444

4545
jobs:
@@ -48,7 +48,7 @@ jobs:
4848
outputs:
4949
tx-hash: ${{ steps.safe-transaction.outputs.tx-hash }}
5050
tx-details: ${{ steps.safe-transaction.outputs.tx-details }}
51-
51+
5252
steps:
5353
- name: Checkout repository
5454
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
@@ -58,7 +58,7 @@ jobs:
5858
- name: Setup Node.js
5959
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
6060
with:
61-
node-version: '22'
61+
node-version: "22"
6262

6363
- name: Install dependencies
6464
run: npm ci

‎.github/workflows/rust-build.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ on:
44
workflow_call:
55
inputs:
66
rust-version:
7-
description: 'Rust version to use'
8-
default: 'stable'
7+
description: "Rust version to use"
8+
default: "stable"
99
type: string
1010
working-directory:
11-
description: 'The directory to run jobs from'
12-
default: '.'
11+
description: "The directory to run jobs from"
12+
default: "."
1313
type: string
1414
enable-cache:
15-
description: 'Enable caching of dependencies'
15+
description: "Enable caching of dependencies"
1616
default: true
1717
type: boolean
1818
publish-crates-io:
19-
description: 'Publish package to crates.io'
19+
description: "Publish package to crates.io"
2020
default: false
2121
type: boolean
2222
secrets:
@@ -26,7 +26,7 @@ on:
2626
env:
2727
CARGO_TERM_COLOR: always
2828
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
29-
29+
3030
jobs:
3131
build_and_publish:
3232
runs-on: ubuntu-latest
@@ -80,7 +80,7 @@ jobs:
8080
- name: Check documentation
8181
working-directory: ${{ inputs.working-directory }}
8282
env:
83-
RUSTDOCFLAGS: '-D warnings'
83+
RUSTDOCFLAGS: "-D warnings"
8484
run: cargo doc --locked --no-deps --document-private-items
8585

8686
- name: Validate package

‎.github/workflows/validate-release-please-config.yml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ on:
55
branches:
66
- main
77
paths:
8-
- 'release-please-config.json'
9-
- 'scripts/check-release-please-config.sh'
10-
- '.github/workflows/validate-release-please-config.yml'
8+
- "release-please-config.json"
9+
- "scripts/check-release-please-config.sh"
10+
- ".github/workflows/validate-release-please-config.yml"
1111
push:
1212
branches:
1313
- main
1414
paths:
15-
- 'release-please-config.json'
16-
- 'scripts/check-release-please-config.sh'
17-
- '.github/workflows/validate-release-please-config.yml'
15+
- "release-please-config.json"
16+
- "scripts/check-release-please-config.sh"
17+
- ".github/workflows/validate-release-please-config.yml"
1818

1919
permissions:
2020
contents: read

‎.github/workflows/verify-workflow-sha256.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ on:
55
branches:
66
- main
77
paths:
8-
- '.github/workflows/*.yml'
9-
- 'release-please-config.json'
10-
- 'scripts/compute-workflow-sha256.sh'
11-
- '**/workflow-sha256'
8+
- ".github/workflows/*.yml"
9+
- "release-please-config.json"
10+
- "scripts/compute-workflow-sha256.sh"
11+
- "**/workflow-sha256"
1212
push:
1313
branches:
1414
- main
1515
paths:
16-
- '.github/workflows/*.yml'
17-
- 'release-please-config.json'
18-
- 'scripts/compute-workflow-sha256.sh'
19-
- '**/workflow-sha256'
16+
- ".github/workflows/*.yml"
17+
- "release-please-config.json"
18+
- "scripts/compute-workflow-sha256.sh"
19+
- "**/workflow-sha256"
2020

2121
permissions:
2222
contents: read

‎conventional-commits/README.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
# 📝 Conventional Commits Workflow
22

33
## 🔍 Overview
4+
45
This reusable GitHub Actions workflow validates that pull request titles follow the [Conventional Commits](https://www.conventionalcommits.org/) specification. Conventional Commits provide a standardized format for commit messages, making it easier to generate changelogs, automate versioning, and understand the purpose of changes at a glance. By enforcing this standard, your repository maintains a clean and meaningful history that benefits both developers and automated tools.
56

67
## 📚 What are Conventional Commits?
8+
79
Conventional Commits follow this structured format:
10+
811
```
912
<type>[optional scope]: <description>
1013
@@ -14,6 +17,7 @@ Conventional Commits follow this structured format:
1417
```
1518

1619
### 🏷️ Common Types Include:
20+
1721
- `✨ feat`: A new feature that adds functionality to your codebase
1822
- `🐛 fix`: A bug fix that resolves an issue or problem
1923
- `📖 docs`: Documentation changes or improvements
@@ -25,6 +29,7 @@ Conventional Commits follow this structured format:
2529
- `🔒 security`: Fixing security vulnerabilities or enhancing security
2630

2731
## 🌟 Benefits
32+
2833
- **📋 Automated Changelog Generation**: Works seamlessly with tools like release-please to create detailed, organized changelogs without manual effort
2934
- **🔢 Semantic Versioning Automation**: Helps determine version bumps based on commit types (major, minor, patch) following SemVer principles
3035
- **📊 Improved Repository History**: Makes your project history more readable, structured, and navigable for all team members
@@ -37,10 +42,11 @@ Conventional Commits follow this structured format:
3742
### 🔐 Secrets
3843

3944
| Name | Description | Required |
40-
|------|-------------|----------|
45+
| --- | --- | --- |
4146
| `GITHUB_TOKEN` | GitHub token for authentication and PR interactions | Yes |
4247

4348
### 🛡️ Permissions
49+
4450
The workflow requires `pull-requests: read` permission to access PR information and validate titles effectively.
4551

4652
## 💻 Example Usage
@@ -63,13 +69,15 @@ jobs:
6369
```
6470
6571
## 📋 Implementation Notes
72+
6673
- 🔄 The workflow runs automatically when PRs are opened, edited, or reopened to ensure continuous validation
6774
- ✅ It validates the PR title against the Conventional Commits specification with comprehensive checks
6875
- 💬 If validation fails, the workflow writes detailed guidance on how to fix the title to the job summary
6976
- 🔗 This workflow is particularly useful when combined with the release-please workflow for a fully automated release process
7077
- 🚀 Helps maintain a high-quality repository that's ready for automated versioning and changelog generation
7178
7279
## 🛠️ Troubleshooting
80+
7381
- If PR titles are consistently failing validation, consider providing team training on Conventional Commits
7482
- For complex projects, you may want to define custom scopes that align with your project's architecture
7583
- Remember that only the PR title needs to follow the convention, not every commit message (though that's also beneficial)

‎docker-build-cloud/README.md‎

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,27 @@ This reusable GitHub Actions workflow builds and pushes a multi-platform Docker
1212
- 🚀 No QEMU emulation, no native ARM runners — DBC handles arch-specific builds
1313
- 📜 Generates & signs a keyless SLSA build provenance attestation (optional)
1414

15-
> [!IMPORTANT]
16-
> Requires a Docker Build Cloud subscription and a builder configured in your DockerHub organization. The DockerHub PAT must have the **Build** scope to authenticate to the cloud endpoint.
17-
18-
## ⚙️ Inputs
19-
20-
| Name | Description | Required | Default |
21-
| ------------------------ | --------------------------------------------------------------------------------- | -------- | -------------- |
22-
| `attest` | Generate & sign a keyless SLSA build provenance attestation for the pushed image (requires caller permissions, see notes) | No | `false` |
23-
| `build-args` | Docker build arguments (multiline format: `KEY1=value1\nKEY2=value2`) | No | `""` |
24-
| `cloud-builder-endpoint` | Docker Build Cloud endpoint, format `<dbc-org>/<builder>` | Yes | - |
25-
| `context` | Path to Docker Build Context | No | `"."` |
26-
| `dockerfile` | Path to the Dockerfile (e.g. `'./Dockerfile'`, `'./docker/Dockerfile'`) | No | `"Dockerfile"` |
27-
| `image-name` | Name of Docker Image, fully qualified (e.g. `iexechub/my-image`) | Yes | - |
28-
| `image-tag` | Tag to apply to the built image (e.g. `1.0.0`, no v prefix) | Yes | - |
29-
| `platforms` | Comma-separated build platforms (e.g. `linux/amd64,linux/arm64`) | Yes | - |
15+
> [!IMPORTANT] Requires a Docker Build Cloud subscription and a builder configured in your DockerHub organization. The DockerHub PAT must have the **Build** scope to authenticate to the cloud endpoint.
16+
17+
## ⚙️ Inputs
18+
19+
| Name | Description | Required | Default |
20+
| --- | --- | --- | --- |
21+
| `attest` | Generate & sign a keyless SLSA build provenance attestation for the pushed image (requires caller permissions, see notes) | No | `false` |
22+
| `build-args` | Docker build arguments (multiline format: `KEY1=value1\nKEY2=value2`) | No | `""` |
23+
| `cloud-builder-endpoint` | Docker Build Cloud endpoint, format `<dbc-org>/<builder>` | Yes | - |
24+
| `context` | Path to Docker Build Context | No | `"."` |
25+
| `dockerfile` | Path to the Dockerfile (e.g. `'./Dockerfile'`, `'./docker/Dockerfile'`) | No | `"Dockerfile"` |
26+
| `image-name` | Name of Docker Image, fully qualified (e.g. `iexechub/my-image`) | Yes | - |
27+
| `image-tag` | Tag to apply to the built image (e.g. `1.0.0`, no v prefix) | Yes | - |
28+
| `platforms` | Comma-separated build platforms (e.g. `linux/amd64,linux/arm64`) | Yes | - |
3029

3130
## 🔐 Secrets
3231

33-
| Name | Description | Required |
34-
| -------------------- | ------------------------------------------------------------------------------------------ | -------- |
35-
| `dockerhub-username` | Username for Docker Hub authentication | Yes |
36-
| `dockerhub-password` | Personal Access Token for Docker Hub with the **Build** scope (needed for DBC endpoint) | Yes |
32+
| Name | Description | Required |
33+
| --- | --- | --- |
34+
| `dockerhub-username` | Username for Docker Hub authentication | Yes |
35+
| `dockerhub-password` | Personal Access Token for Docker Hub with the **Build** scope (needed for DBC endpoint) | Yes |
3736

3837
## 💻 Example Usage
3938

@@ -43,7 +42,7 @@ name: Build and Push Release Image
4342
on:
4443
push:
4544
tags:
46-
- 'v*.*.*'
45+
- "v*.*.*"
4746

4847
jobs:
4948
build-multiplatform:

‎docker-build-cloud/workflow-sha256‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
f364b67e9d5c3795461d15b7bab21adddcd63490e097a15aa82678f80212bff4
1+
6e473c36fb9cf55f91ebdfaa863b7019b2b143f63b20b618ef53c2229023ab05

0 commit comments

Comments
 (0)