Skip to content

Commit 89d1c0c

Browse files
Update readme file
1 parent 1ec070f commit 89d1c0c

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,29 @@ describe.each([
105105
});
106106
}
107107
);
108-
```
108+
```
109+
110+
## GitHub Actions
111+
### GitHub Actions - Nightly Workflow
112+
This repository includes a GitHub Actions workflow that runs every night at midnight (UTC). The workflow is triggered using a cron schedule and is designed to automate tasks like testing on a daily basis.
113+
114+
#### Workflow Details:
115+
- **Trigger Time:** Midnight (00:00 UTC) every day.
116+
- **Workflow File:** [`.github/workflows/nightly-workflow.yml`](.github/workflows/nightly-workflow.yml)
117+
- **Key Tasks:**
118+
- Automatically checks out the repository.
119+
- Executes sanity tests
120+
121+
### GitHub Actions - Run Tests By Group
122+
This repository includes a GitHub Actions workflow that allows you to run specific groups of tests on demand. The workflow can be manually triggered via the GitHub interface using `workflow_dispatch`, where you can select a test group to run.
123+
124+
### Workflow Details:
125+
- **Trigger:** Manually using the `Run workflow` button from the GitHub Actions tab.
126+
- **Workflow File:** [`.github/workflows/run-tests-by-group.yml`](.github/workflows/run-tests-by-group.yml)
127+
- **Test Group Options:**
128+
- `all`: Runs the full test suite.
129+
- `sanity`: Runs a sanity check with a smaller set of key tests.
130+
- `single_character`: Runs tests related to a single character.
131+
- `all_characters`: Runs tests for all characters.
132+
- `multiple_characters`: Runs tests involving multiple characters.
133+
- `filter_characters`: Runs tests that filter characters.

0 commit comments

Comments
 (0)