Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,15 @@ Configuration inheritance/overrides are documented in each workflow section belo

### build.yaml

Docker-based build and test workflow using the `scritical/private-dev` image.
Runs GCC and/or Intel jobs based on `GCC` and `INTEL` input flags.
Docker-based build and test workflow using the `scritical/private-dev` image with GCC and Intel compilers.

| Name | Type | Default | Description |
| :--- | :--- | :------ | :---------- |
| `TIMEOUT` | number | `120` | Runtime allowed for the job, in minutes |
| `GCC_CONFIG` | string | `""` | Path to GCC configuration file (from repository root) |
| `INTEL_CONFIG` | string | `""` | Path to Intel configuration file (from repository root) |
| `BUILD_SCRIPT` | string | `.github/build_real.sh` | Path to build script. Empty string skips this step |
| `TEST_SCRIPT` | string | `.github/test_real.sh` | Path to test script. Empty string skips this step |
| `BUILD_SCRIPT` | string | `.github/build.sh` | Path to build script. Empty string skips this step |
| `TEST_SCRIPT` | string | `.github/test.sh` | Path to test script. Empty string skips this step |

**Required Secrets:**
| Name | Description |
Expand All @@ -75,6 +74,7 @@ The workflow checks out the org-wide Ruff configuration from `scritical/.github`

| Name | Type | Default | Description |
| :--- | :--- | :------ | :---------- |
| `TIMEOUT` | number | `20` | Runtime allowed for the job, in minutes |
| `MCCABE` | boolean | `false` | Enable McCabe complexity check (pass/fail, max complexity = 10) |
| `ISORT` | boolean | `false` | Enable import sorting check (pass/fail) |

Expand Down Expand Up @@ -151,7 +151,7 @@ Fortran 90 code formatting checks using fprettify.
Enforces branch naming conventions for pull requests:

- For PRs targeting `main`, source branches must start with `feature-`, `bugfix-`, or `hotfix-`.
- For PRs targeting `client-*`, source branches must start with `feature-`, `bugfix-`, or `hotfix-`.
- For PRs targeting `client-*`, source branches must be `main` or start with `feature-`, `bugfix-`, or `hotfix-`.

## Setting Up Workflows

Expand Down Expand Up @@ -187,7 +187,7 @@ jobs:

### Step 2: Write Build Script

Create `.github/build_real.sh` in your repository:
Create `.github/build.sh` in your repository:

```bash
#!/bin/bash
Expand All @@ -199,7 +199,7 @@ pip install .

### Step 3: Write Test Script

Create `.github/test_real.sh` in your repository:
Create `.github/test.sh` in your repository:

```bash
#!/bin/bash
Expand All @@ -210,7 +210,7 @@ testflo -v . -n 1

### Step 4: Add Secrets

In your orginaization settings, add the required secrets:
In your organization settings, add the required secrets:
- `DOCKER_USER` - Docker organization name
- `DOCKER_OAT` - Docker Organization Access Token for pulling private images

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ on:
description: "Path to Intel configuration file"
BUILD_SCRIPT:
type: string
default: ".github/build_real.sh"
default: ".github/build.sh"
description: "Path to build script"
TEST_SCRIPT:
type: string
default: ".github/test_real.sh"
default: ".github/test.sh"
description: "Path to test script"
secrets:
DOCKER_USER:
Expand Down
29 changes: 0 additions & 29 deletions .pre-commit-config.yaml

This file was deleted.

Loading