File tree Expand file tree Collapse file tree 7 files changed +58
-27
lines changed
Expand file tree Collapse file tree 7 files changed +58
-27
lines changed Original file line number Diff line number Diff line change 1- # iExec reusable workflow repository
1+ # 🔄 iExec Reusable Workflow Repository
22
3- This repository contains a reusable workflow for iExec. It is a monorepo that contains the following components:
3+ 📝 This repository contains reusable workflows for iExec. It is a monorepo that contains the following components:
44
5- ## Components
5+ ## 📦 Components
66
7- ### [ Build Docker Image] ( ./docker-build )
7+ ### 🐳 [ Build Docker Image] ( ./docker-build )
88This workflow builds a Docker image from a Dockerfile. It is a reusable workflow that can be used in other workflows.
99
10- ### [ Release Please] ( ./release-please )
10+ ### 🚀 [ Release Please] ( ./release-please )
1111This workflow uses the [ release-please-action] ( https://github.com/googleapis/release-please-action ) to automate the release of a project.
1212
13- ### [ Publish NPM Package] ( ./publish-npm )
13+ ### 📦 [ Publish NPM Package] ( ./publish-npm )
1414This workflow publishes an NPM package to the NPM registry.
1515
16- ### [ Conventional Commits] ( ./conventional-commits )
16+ ### ✅ [ Conventional Commits] ( ./conventional-commits )
1717This workflow checks that pull request titles follow the [ Conventional Commits] ( https://www.conventionalcommits.org/ ) specification.
18+
19+ ### 🦀 [ Rust Build] ( ./rust-build )
20+ This workflow builds and tests Rust projects.
21+
22+ ### 🧹 [ Stale] ( ./stale )
23+ This workflow marks and closes stale issues and pull requests.
Original file line number Diff line number Diff line change 1- # Conventional Commits
1+ # ✅ Conventional Commits
22
3- This workflow checks that pull request titles follow the [ Conventional Commits] ( https://www.conventionalcommits.org/ ) specification.
3+ 📝 This workflow checks that pull request titles follow the [ Conventional Commits] ( https://www.conventionalcommits.org/ ) specification.
44
5- ## Secrets
5+ ## 🔒 Secrets
66
77### ` GITHUB_TOKEN `
88
99** Required** The GitHub token to use for authentication.
1010
11- ## Example usage
11+ ## 📋 Example Usage
1212
1313``` yaml
1414name : Lint PR Title
2525 uses :
iExecBlockchainComputing/github-actions-workflows/.github/workflows/[email protected] 2626 secrets :
2727 GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
28- ` ` `
28+ ` ` `
Original file line number Diff line number Diff line change 1+ 1.0.0
Original file line number Diff line number Diff line change 1- # Docker build
1+ # 🐳 Docker Build
22
3- ## Inputs
3+ 📝 This workflow builds a Docker image from a Dockerfile and pushes it to Docker Hub.
4+
5+ ## ⚙️ Inputs
46
57### ` dockerfile `
68
1012
1113** Required** The tag to apply to the built image.
1214
13- ## Secrets
15+ ## 🔒 Secrets
1416
1517### ` dockerhub_username `
1618
2022
2123** Required** The personal access token to use to log in to Docker Hub.
2224
23- ## Example usage
25+ ## 📋 Example Usage
2426
2527``` yaml
2628uses :
iExecBlockchainComputing/github-actions-workflows/[email protected]
Original file line number Diff line number Diff line change 1- # Rust Build Workflow
1+ # 🦀 Rust Build Workflow
22
3- A reusable GitHub Actions workflow for building, testing, and publishing Rust packages.
3+ 📝 A reusable GitHub Actions workflow for building, testing, and publishing Rust packages.
44
5- ## Features
5+ ## ✨ Features
66
77- Build and test Rust packages
88- Cache dependencies for faster builds
99- Publish packages to crates.io
1010- Upload build artifacts
1111
12- ## Usage
12+ ## 📋 Usage
1313
1414``` yaml
1515name : Rust CI
2828 artifact-path : ' target/release/my-app'
2929` ` `
3030
31- ## Inputs
31+ ## ⚙️ Inputs
3232
3333| Name | Description | Default | Required |
3434|---------------------|----------------------------------------------------|-----------|-------------------------------------|
@@ -40,13 +40,13 @@ jobs:
4040| `artifact-name` | Name of the artifact to upload | - | Only if `upload-artifact` is `true` |
4141| `artifact-path` | Path to the artifact to upload | - | Only if `upload-artifact` is `true` |
4242
43- # # Secrets
43+ # # 🔒 Secrets
4444
4545| Name | Description | Required |
4646|-------------------|-----------------------------------|---------------------------------------|
4747| `CRATES_IO_TOKEN` | Token for publishing to crates.io | Only if `publish-crates-io` is `true` |
4848
49- # # Examples
49+ # # 📚 Examples
5050
5151# ## Basic Build and Test
5252
7878 publish-crates-io: true
7979 secrets:
8080 CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
81- ` ` `
81+ ` ` `
Original file line number Diff line number Diff line change 1+ 1.0.0
Original file line number Diff line number Diff line change 1- # Docker build
1+ # 🧹 Stale
22
3- ## Example usage
3+ 📝 This workflow marks and closes stale issues and pull requests that have had no activity for a specified period of time.
4+
5+ ## 📋 Example Usage
46
57``` yaml
6- uses :
iExecBlockchainComputing/github-actions-workflows/[email protected] 8+ name : Mark stale issues and pull requests
9+
10+ on :
11+ schedule :
12+ - cron : ' 0 0 * * *' # Run daily at midnight
13+
14+ jobs :
15+ stale :
16+ uses :
iExecBlockchainComputing/github-actions-workflows/[email protected] 717` ` `
18+
19+ ## ⚙️ Default Configuration
20+
21+ This workflow uses GitHub's built-in stale action with the following default settings:
22+
23+ - Issues and pull requests with no activity for 60 days are marked as stale
24+ - Stale issues and pull requests are closed after 7 days of inactivity
25+ - Issues with the "pinned" label are never marked as stale
26+ - A comment is posted when an issue or pull request is marked as stale
27+
28+ For more information, see the [GitHub documentation on the stale action](https://github.com/actions/stale).
You can’t perform that action at this time.
0 commit comments