Skip to content

Commit 8da3194

Browse files
authored
Merge pull request #637 from github/experiment/github-pages-website
website
2 parents 7feee42 + a1da290 commit 8da3194

Some content is hidden

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

42 files changed

+12549
-2
lines changed
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# GitHub Pages deployment workflow
2+
# Builds the Astro website and deploys to GitHub Pages
3+
4+
name: Deploy Website to GitHub Pages
5+
6+
on:
7+
# Runs on pushes targeting the default branch
8+
push:
9+
branches: ["main"]
10+
paths:
11+
- "website/**"
12+
- "agents/**"
13+
- "prompts/**"
14+
- "instructions/**"
15+
- "skills/**"
16+
- "collections/**"
17+
- "cookbook/**"
18+
- "eng/generate-website-data.mjs"
19+
- ".github/workflows/deploy-website.yml"
20+
21+
# Allows you to run this workflow manually from the Actions tab
22+
workflow_dispatch:
23+
24+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
25+
permissions:
26+
contents: read
27+
pages: write
28+
id-token: write
29+
30+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
31+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
32+
concurrency:
33+
group: "pages"
34+
cancel-in-progress: false
35+
36+
jobs:
37+
# Build job
38+
build:
39+
runs-on: ubuntu-latest
40+
steps:
41+
- name: Checkout
42+
uses: actions/checkout@v4
43+
44+
- name: Setup Node.js
45+
uses: actions/setup-node@v4
46+
with:
47+
node-version: "20"
48+
cache: "npm"
49+
50+
- name: Install root dependencies
51+
run: npm ci
52+
53+
- name: Install website dependencies
54+
run: npm ci
55+
working-directory: ./website
56+
57+
- name: Generate website data
58+
run: npm run website:data
59+
60+
- name: Build Astro site
61+
run: npm run build
62+
working-directory: ./website
63+
64+
- name: Setup Pages
65+
uses: actions/configure-pages@v5
66+
67+
- name: Upload artifact
68+
uses: actions/upload-pages-artifact@v3
69+
with:
70+
path: "./website/dist"
71+
72+
# Deployment job
73+
deploy:
74+
environment:
75+
name: github-pages
76+
url: ${{ steps.deployment.outputs.page_url }}
77+
runs-on: ubuntu-latest
78+
needs: build
79+
steps:
80+
- name: Deploy to GitHub Pages
81+
id: deployment
82+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,8 @@ reports/
66
# macOS system files
77
.DS_Store
88
*.tmp
9+
10+
# Website build artifacts
11+
website/dist/
12+
website/.astro/
13+
website/public/data/*

.schemas/cookbook.schema.json

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema#",
3+
"title": "Cookbook Manifest",
4+
"description": "Schema for cookbook.yml manifest defining cookbooks and recipes",
5+
"type": "object",
6+
"required": ["cookbooks"],
7+
"properties": {
8+
"cookbooks": {
9+
"type": "array",
10+
"description": "List of cookbooks",
11+
"items": {
12+
"type": "object",
13+
"required": ["id", "name", "description", "path", "languages", "recipes"],
14+
"properties": {
15+
"id": {
16+
"type": "string",
17+
"description": "Unique identifier for the cookbook",
18+
"pattern": "^[a-z0-9-]+$"
19+
},
20+
"name": {
21+
"type": "string",
22+
"description": "Display name for the cookbook"
23+
},
24+
"description": {
25+
"type": "string",
26+
"description": "Brief description of the cookbook"
27+
},
28+
"path": {
29+
"type": "string",
30+
"description": "Relative path to the cookbook folder"
31+
},
32+
"featured": {
33+
"type": "boolean",
34+
"description": "Whether this cookbook should be featured",
35+
"default": false
36+
},
37+
"languages": {
38+
"type": "array",
39+
"description": "Programming languages supported by this cookbook",
40+
"items": {
41+
"type": "object",
42+
"required": ["id", "name"],
43+
"properties": {
44+
"id": {
45+
"type": "string",
46+
"description": "Language identifier (folder name)",
47+
"pattern": "^[a-z0-9-]+$"
48+
},
49+
"name": {
50+
"type": "string",
51+
"description": "Display name for the language"
52+
},
53+
"icon": {
54+
"type": "string",
55+
"description": "Emoji icon for the language"
56+
},
57+
"extension": {
58+
"type": "string",
59+
"description": "File extension for runnable examples",
60+
"pattern": "^\\.[a-z]+$"
61+
}
62+
}
63+
}
64+
},
65+
"recipes": {
66+
"type": "array",
67+
"description": "List of recipes in this cookbook",
68+
"items": {
69+
"type": "object",
70+
"required": ["id", "name", "description"],
71+
"properties": {
72+
"id": {
73+
"type": "string",
74+
"description": "Recipe identifier (matches markdown filename without extension)",
75+
"pattern": "^[a-z0-9-]+$"
76+
},
77+
"name": {
78+
"type": "string",
79+
"description": "Display name for the recipe"
80+
},
81+
"description": {
82+
"type": "string",
83+
"description": "Brief description of what the recipe covers"
84+
},
85+
"tags": {
86+
"type": "array",
87+
"description": "Tags for filtering and categorization",
88+
"items": {
89+
"type": "string"
90+
}
91+
}
92+
}
93+
}
94+
}
95+
}
96+
}
97+
}
98+
}
99+
}

.schemas/tools.schema.json

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema#",
3+
"title": "Tools Catalog",
4+
"description": "Schema for the awesome-copilot tools catalog (website/data/tools.yml)",
5+
"type": "object",
6+
"required": ["tools"],
7+
"additionalProperties": false,
8+
"properties": {
9+
"tools": {
10+
"type": "array",
11+
"description": "List of tools in the catalog",
12+
"minItems": 1,
13+
"items": {
14+
"type": "object",
15+
"required": ["id", "name", "description", "category"],
16+
"additionalProperties": false,
17+
"properties": {
18+
"id": {
19+
"type": "string",
20+
"description": "Unique identifier for the tool",
21+
"pattern": "^[a-z0-9-]+$",
22+
"minLength": 1,
23+
"maxLength": 50
24+
},
25+
"name": {
26+
"type": "string",
27+
"description": "Display name for the tool",
28+
"minLength": 1,
29+
"maxLength": 100
30+
},
31+
"description": {
32+
"type": "string",
33+
"description": "Description of what this tool does",
34+
"minLength": 1,
35+
"maxLength": 1000
36+
},
37+
"category": {
38+
"type": "string",
39+
"description": "Category for grouping tools",
40+
"minLength": 1,
41+
"maxLength": 50,
42+
"examples": ["MCP Servers", "VS Code Extensions", "CLI Tools", "Visual Studio Extensions"]
43+
},
44+
"featured": {
45+
"type": "boolean",
46+
"description": "Whether this tool is featured (shown first)",
47+
"default": false
48+
},
49+
"requirements": {
50+
"type": "array",
51+
"description": "List of requirements to use this tool",
52+
"items": {
53+
"type": "string",
54+
"minLength": 1,
55+
"maxLength": 200
56+
},
57+
"maxItems": 10
58+
},
59+
"features": {
60+
"type": "array",
61+
"description": "List of key features",
62+
"items": {
63+
"type": "string",
64+
"minLength": 1,
65+
"maxLength": 200
66+
},
67+
"maxItems": 20
68+
},
69+
"links": {
70+
"type": "object",
71+
"description": "Links related to this tool",
72+
"additionalProperties": false,
73+
"properties": {
74+
"blog": {
75+
"type": "string",
76+
"description": "Link to a blog post about the tool",
77+
"format": "uri"
78+
},
79+
"documentation": {
80+
"type": "string",
81+
"description": "Link to documentation",
82+
"format": "uri"
83+
},
84+
"github": {
85+
"type": "string",
86+
"description": "Link to GitHub repository",
87+
"format": "uri"
88+
},
89+
"marketplace": {
90+
"type": "string",
91+
"description": "Link to VS Code or Visual Studio Marketplace",
92+
"format": "uri"
93+
},
94+
"npm": {
95+
"type": "string",
96+
"description": "Link to npm package",
97+
"format": "uri"
98+
},
99+
"pypi": {
100+
"type": "string",
101+
"description": "Link to PyPI package",
102+
"format": "uri"
103+
},
104+
"vscode": {
105+
"type": "string",
106+
"description": "VS Code install link (vscode: URI or aka.ms link)"
107+
},
108+
"vscode-insiders": {
109+
"type": "string",
110+
"description": "VS Code Insiders install link"
111+
},
112+
"visual-studio": {
113+
"type": "string",
114+
"description": "Visual Studio install link"
115+
}
116+
}
117+
},
118+
"configuration": {
119+
"type": "object",
120+
"description": "Configuration snippet for the tool",
121+
"required": ["type", "content"],
122+
"additionalProperties": false,
123+
"properties": {
124+
"type": {
125+
"type": "string",
126+
"description": "Type of configuration (for syntax highlighting)",
127+
"enum": ["json", "yaml", "bash", "toml", "ini"]
128+
},
129+
"content": {
130+
"type": "string",
131+
"description": "The configuration content"
132+
}
133+
}
134+
},
135+
"tags": {
136+
"type": "array",
137+
"description": "Tags for filtering and discovery",
138+
"items": {
139+
"type": "string",
140+
"pattern": "^[a-z0-9-]+$",
141+
"minLength": 1,
142+
"maxLength": 30
143+
},
144+
"uniqueItems": true,
145+
"maxItems": 15
146+
}
147+
}
148+
}
149+
}
150+
}
151+
}

.vscode/settings.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
"*.prompt.md": "prompt"
1616
},
1717
"yaml.schemas": {
18-
"./.schemas/collection.schema.json": "*.collection.yml"
18+
"./.schemas/collection.schema.json": "*.collection.yml",
19+
"./.schemas/tools.schema.json": "website/data/tools.yml",
1920
}
2021
}

0 commit comments

Comments
 (0)