Skip to content

Commit

Permalink
Updated the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jplodge-pro committed Jul 8, 2024
1 parent fe14b64 commit 9bb6134
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,50 @@
## Running Actions Locally

### Pre-requisite

1. Install act https://nektosact.com/installation/index.html
2. Jobs should be run from root folder (.././/)

### List Jobs

List jobs, with optional "--container-architecture" flag for Mac m chips

```bash
act --list --container-architecture linux/amd64
```

### Run check-env sample jobs
Run all jobs in ci-check-env.yml. Pass in an .env file as Environment variables and Secrets

Run all jobs in ci-check-env.yml. Pass in an .env file as Environment variables and Secrets

```bash
act -W .github/workflows/ci-check-env.yml --var-file packages/contracts/.env --secret-file packages/contracts/.secret --container-architecture linux/amd64
```

### Run Contracts jobs

Runs the contracts job - only the Env should be an .env (configs are in .toml) - local secrets are in .env

```bash
act -W .github/workflows/ci-dev-contracts.yml --var ENVIRONMENT=local --secret-file packages/contracts/.env --container-architecture linux/amd64
```

### Run API jobs

Runs the api job - only the Env should be an .env (configs are in .toml) - local secrets are in .env

```bash
act -W .github/workflows/ci-dev-api.yml --var ENVIRONMENT=local --secret-file packages/api/.env --container-architecture linux/amd64
```

### Run Ops jobs

Runs the ops job - only the Env should be an .env (configs are in .toml) - local secrets are in .env

```bash
act -W .github/workflows/ci-dev-ops.yml --var ENVIRONMENT=ci --secret-file packages/ops/.env --container-architecture linux/amd64
```
```

### Github Action Limitations

The workflows `ci-dev-sdk.yml` and `ci-dev-ops.yml` are nigh on identical, using a 'local' setup for CI invocation. An attempt to resolve this duplication of content using GitHub's Reusable Workflows was made, but that mechanism has proven unsuitable. As yet, no suitable mechanism is known, so we have duplication.

0 comments on commit 9bb6134

Please sign in to comment.