Skip to content
This repository was archived by the owner on May 4, 2026. It is now read-only.

Commit ac37887

Browse files
committed
fix README.md
1 parent 16172b6 commit ac37887

4 files changed

Lines changed: 18 additions & 7 deletions

File tree

.github/workflows/test.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,4 @@ jobs:
1414
- name: Run gomarklint Action
1515
uses: ./
1616
with:
17-
args: |
18-
--config
19-
testdata/.gomarklint.json
20-
testdata/markdown_files
17+
args: testdata

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
# gomarklint-action
22

33
Lint Markdown files using [gomarklint](https://github.com/shinagawa-web/gomarklint) in GitHub Actions.
4+
## 🚀 Prerequisites
5+
6+
Before using this action, please generate a `.gomarklint.json` config file with:
7+
8+
```bash
9+
gomarklint init
10+
```
11+
12+
This config file is required. If it is missing, the action will fail.
13+
14+
See the [gomarklint documentation](https://github.com/shinagawa-web/gomarklint/blob/main/README.md) for details.
415

516
## Usage
617

entrypoint.sh

100644100755
Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
#!/bin/sh
22
set -e
33

4-
if [ -f ".gomarklint.json" ]; then
5-
echo "✅ Found .gomarklint.json"
4+
CONFIG_FILE=".gomarklint.json"
5+
6+
if [ -f "$CONFIG_FILE" ]; then
7+
echo "✅ Found $CONFIG_FILE"
68
else
7-
echo "⚠️ .gomarklint.json not found. Proceeding with default config."
9+
echo "$CONFIG_FILE not found. This action requires a config file."
10+
exit 1
811
fi
912

1013
exec gomarklint "$@"

0 commit comments

Comments
 (0)