Skip to content

Commit 64d9f6c

Browse files
docs: add documentation for file-exists action
1 parent e21c7da commit 64d9f6c

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ This repository serves as a comprehensive toolkit for creating and managing GitH
2222

2323
- **[.github/workflows](/.github/workflows)**: GitHub Actions workflows for automating common parts of Skills Exercises
2424
- **[markdown-templates](/markdown-templates)**: Ready-to-use Markdown templates for creating consistent exercise documentation, instructions, and README files
25+
- **[actions](/actions)**: Simple composite actions to help when building GitHub Skills exercises
26+
2527

2628
## Examples
2729

actions/file-exists/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# File Exists :package:
2+
3+
A GitHub Action that checks if a file exists in the repository.
4+
5+
This action will fail if the file does not exist
6+
7+
## Inputs ⚙️
8+
9+
| Name | Description | Required |
10+
| ------ | -------------------------------------------------------------- | -------- |
11+
| `file` | The path to the file to check, relative to the repository root | Yes |
12+
13+
## Usage 🚀
14+
15+
```yaml
16+
steps:
17+
- uses: actions/checkout@v4
18+
- name: Check if file exists
19+
uses: skills/exercise-toolkit/actions/file-exists@<git-tag>
20+
with:
21+
file: "path/to/your/file.md"
22+
```

0 commit comments

Comments
 (0)