Skip to content
Open
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
31 changes: 31 additions & 0 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Validate Meeting Notes

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
validate:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'

- name: Install dependencies
run: npm ci

- name: Validate frontmatter
run: npm run validate

- name: Success message
if: success()
run: echo "✅ All meeting notes validated successfully!"
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/
npm-debug.log*
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,23 @@ Its goal is to provide a transparent and accessible record of:

There notes are public and intended for contributors, stakeholders, and anyone interested in the project's evolution.

## Validation

Meeting notes are automatically validated for consistency. Each file must include:

- **Frontmatter** with:
- `date` (YYYY-MM-DD)
- `type` (`users` or `contributors`)
- **Filename** containing the date in YYYYMMDD format (e.g., `20240117.md`)
- **Directory** structure matching `{type}/{YYYY}/`

Run validation locally:

```bash
npm install
npm run validate
```

## Related

- Main repository: <https://github.com/OKDP/OKDP>
Expand Down
310 changes: 310 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "okdp-meeting-notes",
"version": "1.0.0",
"description": "OKDP Meeting Notes",
"private": true,
"scripts": {
"validate": "node scripts/validate-frontmatter.js"
},
"devDependencies": {
"ajv": "^8.20.0",
"ajv-formats": "^3.0.1",
"glob": "^13.0.6",
"gray-matter": "^4.0.3"
},
"engines": {
"node": ">=16"
},
"repository": {
"type": "git",
"url": "https://github.com/OKDP/meeting-notes"
},
"license": "Apache-2.0"
}
Loading
Loading