Skip to content

Commit dcae2ab

Browse files
committed
chore: update markdownlint configuration and CI workflows
- Added new markdownlint rule for padded style in `.markdownlint.jsonc`. - Updated `.pre-commit-config.yaml` to include arguments for preserving double-space hard line breaks in markdown. - Modified CI workflow to remove markdown validation steps and streamline job outputs. - Adjusted markdown tables in documentation for consistency and clarity. - Enhanced `.gitignore` and Docker Compose files for better resource management and organization.
1 parent 24ac8ed commit dcae2ab

49 files changed

Lines changed: 1058 additions & 563 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/ci.yml

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,6 @@ jobs:
5959
timeout-minutes: 5
6060
outputs:
6161
src: ${{ steps.filter.outputs.src }}
62-
markdown: ${{ steps.filter.outputs.markdown }}
63-
markdown_files: ${{ steps.filter.outputs.markdown_files }}
6462
shell: ${{ steps.filter.outputs.shell }}
6563
steps:
6664
- name: Checkout repository
@@ -81,8 +79,6 @@ jobs:
8179
- "pyproject.toml"
8280
- "uv.lock"
8381
- ".github/workflows/ci.yml"
84-
markdown:
85-
- "**/*.md"
8682
shell:
8783
- "**/*.sh"
8884
- ".github/workflows/ci.yml"
@@ -158,23 +154,6 @@ jobs:
158154
path: coverage.xml
159155
if-no-files-found: warn
160156

161-
markdown-validation:
162-
name: Markdown validation
163-
runs-on: ubuntu-latest
164-
timeout-minutes: 5
165-
needs: changes
166-
if: needs.changes.outputs.markdown == 'true'
167-
steps:
168-
- name: Checkout repository
169-
uses: actions/checkout@v5
170-
171-
- name: Lint Markdown
172-
uses: DavidAnson/markdownlint-cli2-action@992badcdf24e3b8eb7e87ff9287fe931bcb00c6e # v20
173-
with:
174-
config: .markdownlint.jsonc
175-
globs: ${{ needs.changes.outputs.markdown_files }}
176-
separator: ","
177-
178157
shell-script-sanity:
179158
name: Shell script sanity
180159
runs-on: ubuntu-latest

.markdownlint.jsonc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@
55
"MD025": false,
66
"MD031": false,
77
"MD032": false,
8-
"MD040": false
8+
"MD040": false,
9+
"MD060": { "style": "padded" }
910
}

.pre-commit-config.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ repos:
33
rev: v5.0.0
44
hooks:
55
- id: trailing-whitespace
6+
# Preserve double-space hard line breaks in markdown (CommonMark).
7+
args: [--markdown-linebreak-ext=md]
68
- id: end-of-file-fixer
79
- id: check-yaml
810
- id: check-json
@@ -20,3 +22,9 @@ repos:
2022
hooks:
2123
- id: yamllint
2224
args: [-c, .yamllint]
25+
26+
- repo: https://github.com/DavidAnson/markdownlint-cli2
27+
rev: v0.22.1
28+
hooks:
29+
- id: markdownlint-cli2
30+
args: ["--config", ".markdownlint.jsonc"]

AGENTS.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ docker compose -f infra/compose/docker-compose.yml -f infra/compose/docker-compo
180180
### `deploy` — Docker infrastructure management
181181

182182
| Sub-command | Description |
183-
|-------------|-------------|
183+
| --- | --- |
184184
| `open-pulse deploy up` | Deploy services via Docker Compose. Without `--profile` flags, opens an interactive selector. Creates `.env` from `infra/env/.env.example` if absent. |
185185
| `open-pulse deploy down` | Tear down deployed services. `--volumes` / `-v` also removes named volumes. |
186186
| `open-pulse deploy ps` | Show the status of deployed containers. |
@@ -210,7 +210,7 @@ docker compose -f infra/compose/docker-compose.yml -f infra/compose/docker-compo
210210
### `quest` — Analysis pipeline execution
211211

212212
| Sub-command | Description |
213-
|-------------|-------------|
213+
| --- | --- |
214214
| `open-pulse quest start` | Run the full four-step pipeline. Checkpoint files in `.quest-checkpoints/`. |
215215
| `open-pulse quest run <yaml>` | Run a quest YAML directly (synchronous; the hub Pipeline page invokes this). |
216216
| `open-pulse quest run-step <step>` | Run a single step. |
@@ -224,7 +224,7 @@ from `tentris` — the service is now technology-agnostic).
224224
### `services grimoire` — GrimoireLab service tools
225225

226226
| Sub-command | Description |
227-
|-------------|-------------|
227+
| --- | --- |
228228
| `open-pulse services grimoire prepare-config` | Run SPARQL queries and generate a `projects.json`. |
229229
| `open-pulse services grimoire apply` | Query SPARQL, build `projects.json`, POST to the applier sidecar (which writes the file and restarts mordred). |
230230
| `open-pulse services grimoire install-watcher` | Install a cron job that pulls a git repo and detects config changes (Linux/macOS only). |
@@ -235,7 +235,7 @@ the CLI and the hub `/api/projects/*` routes).
235235
### `gui` — Interactive UIs
236236

237237
| Sub-command | Description |
238-
|-------------|-------------|
238+
| --- | --- |
239239
| `open-pulse gui grimoire` | Launch the password-protected Streamlit Grimoire UI (requires `[grimoire-ui]`). |
240240
| `open-pulse gui hub serve` | Run the Open Pulse Hub dashboard. Requires `[hub]`. |
241241

@@ -245,7 +245,7 @@ the compose `hub` service publishes 9090 → 8000.
245245
### `health` — Service health checks
246246

247247
| Usage | Description |
248-
|-------|-------------|
248+
| --- | --- |
249249
| `open-pulse health` | Docker reachability + container status + endpoint probes + smoke tests. |
250250

251251
## Open Pulse Hub
@@ -256,7 +256,7 @@ request → 12h cookie session. All Python ships with the package
256256
(hatchling auto-includes everything under `src/open_pulse/`).
257257

258258
| Path | Purpose |
259-
|---|---|
259+
| --- | --- |
260260
| `/` | Stat cards (services healthy/total, longest uptime, SPARQL repos, Neo4j nodes/rels) · service tiles · quick links |
261261
| `/stack` | Profile checkboxes → `open-pulse deploy {up,down,ps}` exec'd inside the cli container |
262262
| `/services` | Per-container start / stop / restart + logs drawer |

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ leading-slash arguments).
6767
### Profiles
6868

6969
| Profile | What comes up |
70-
|---|---|
70+
| --- | --- |
7171
| `default` | Neo4j |
7272
| `crawler` | Open Pulse Crawler API |
7373
| `extractor` | GME metadata extractor + Selenium |

infra/compose/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ docker compose -f docker-compose.yml \
5454
## Profiles
5555

5656
| Profile | Adds |
57-
|---|---|
57+
| --- | --- |
5858
| `default` | Neo4j (always present; the implicit "no profile" set) |
5959
| `analysis` | Analysis notebook |
6060
| `crawler` | `open-pulse-crawler` |

infra/compose/docker-compose.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,4 +299,3 @@ services:
299299
start_period: 10s
300300
mem_limit: ${HUB_MEM_LIMIT:-512m}
301301
cpus: ${HUB_CPUS:-1.0}
302-
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
cron_logs/
2-
config/setup.cfg
2+
config/setup.cfg

infra/services/grimoirelab/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ curl -u admin:YOUR_PASSWORD -X GET "http://localhost:5601/api/saved_objects/_fin
126126

127127
### Check the indexes and aliases
128128

129-
This allows to confirm the Mordred extraction went well for all your projects in projects.json. You can also confirm by seeing `collection finished` in the Mordred docker logs.
129+
This allows to confirm the Mordred extraction went well for all your projects in projects.json. You can also confirm by seeing `collection finished` in the Mordred docker logs.
130130

131131
It can also be seen on OpenSearch UI under Index Management - Indexes.
132132

@@ -145,6 +145,6 @@ curl -k -u admin:YOUR_PASSWORD -X GET "https://localhost:9200/_cat/aliases?v"
145145
It can also be seen on OpenSearch UI under Dashbaords Management - Saved Objects.
146146

147147
```bash
148-
curl -u admin:YOUR_PASSWORD -X GET "http://localhost:5601/api/saved_objects/_find?type=dashboard" \
148+
curl -u admin:YOUR_PASSWORD -X GET "http://localhost:5601/api/saved_objects/_find?type=dashboard" \
149149
-H "osd-xsrf: true"
150150
```

infra/services/grimoirelab/config/projects.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -999,7 +999,7 @@
999999
"EPFL-ENAC/vue-cli-preset",
10001000
"EPFL-ENAC/web-app",
10011001
"EPFL-ENAC/zarr_geospatial_playground"
1002-
]
1002+
]
10031003
},
10041004
"eth": {
10051005
"meta": {
@@ -1015,4 +1015,4 @@
10151015
]
10161016
}
10171017

1018-
}
1018+
}

0 commit comments

Comments
 (0)