Skip to content
Merged
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
57 changes: 57 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Deploy Pages

on:
push:
branches: [main]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
name: Build site
runs-on: ubuntu-latest

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

- name: Setup Node.js
uses: actions/setup-node@v6
with:
node-version: "24"
cache: "npm"

- name: Install dependencies
run: npm ci

- name: Build GAP website
run: npm run build

- name: Configure Pages
uses: actions/configure-pages@v6

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v5
with:
path: _site

deploy:
name: Deploy site
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
node_modules/
_site/
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Required fields:
```yml
id: <the PR number, or 0 if not yet known>
title: <title>
summary: <one sentence plain-text summary>
# GAPs are never "strawman". Later we'll probably add additional statuses. If in
# doubt, choose "proposal"
status: proposal | draft | accepted
Expand All @@ -61,6 +62,9 @@ sponsor: "@githubUername"
# of this GAP occurs. Otherwise, this can be set to the URL of the PR in which
# the GAP was submited.
discussion: "https://github.com/graphql/graphql-wg/issues/..."
summary: >
A short summary (one or two sentences) of the GAP. Will be displayed on the
GAPs directory website.
```

Additional optional fields:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ Each proposal lives in its own `GAP-N` folder and must include:
- `DRAFT.md` — the working document of the proposal/specification
- `README.md` — a brief overview and status, including challenges/drawbacks and
related resources or prior art
- `metadata.yml` — authorship, sponsorship, status, and related metadata
- `metadata.yml` — summary, authorship, sponsorship, status, and related metadata

See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full GAP process.
11 changes: 10 additions & 1 deletion metadata.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"type": "object",
"properties": {
"title": { "type": "string" },
"summary": { "type": "string" },
"status": { "type": "string", "enum": ["proposal", "draft", "accepted"] },
"authors": { "type": "array", "items": { "type": "string" } },
"sponsor": { "type": "string" },
Expand All @@ -15,6 +16,14 @@
"supersededBy": { "type": "integer" },
"tags": { "type": "array", "items": { "type": "string" } }
},
"required": ["id", "title", "status", "authors", "sponsor", "discussion"],
"required": [
"id",
"title",
"summary",
"status",
"authors",
"sponsor",
"discussion"
],
"additionalProperties": false
}
Loading
Loading