Skip to content

Commit 402537c

Browse files
Seungpyo1007Seungpyo1007
authored
Merge pull request #6 from GetTechAPI/develop
chore(release): prototype v0
2 parents 80763b4 + d0c0bff commit 402537c

21 files changed

Lines changed: 829 additions & 4 deletions

‎.github/CODEOWNERS‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Default owners. The GetTechAPI org has no teams yet.
2+
* @Seungpyo1007
3+
4+
/data/ @Seungpyo1007
5+
/app/ @Seungpyo1007
6+
/.github/ @Seungpyo1007

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: "Bug report"
2+
description: Report a bug in the validator, CI, or site
3+
labels: ["bug"]
4+
body:
5+
- type: textarea
6+
id: what-happened
7+
attributes:
8+
label: What happened?
9+
validations:
10+
required: true
11+
- type: textarea
12+
id: reproduce
13+
attributes:
14+
label: Steps to reproduce
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: expected
19+
attributes:
20+
label: Expected behavior
21+
validations:
22+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/ISSUE_TEMPLATE/data_addition.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: "ES data addition"
2+
description: Request a new engineering-sample CPU record
3+
labels: ["data", "enhancement"]
4+
body:
5+
- type: dropdown
6+
id: sample_class
7+
attributes:
8+
label: Sample class
9+
options:
10+
- es
11+
default: 0
12+
validations:
13+
required: true
14+
- type: input
15+
id: identifier
16+
attributes:
17+
label: Identifier (Intel Q-spec or AMD OPN)
18+
placeholder: "QXLB or 100-000000665-21_N"
19+
validations:
20+
required: true
21+
- type: input
22+
id: manufacturer
23+
attributes:
24+
label: Manufacturer
25+
placeholder: "intel or amd"
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: sources
30+
attributes:
31+
label: Public source URLs (at least one)
32+
description: Vendor leaks on public pages, CPU-World, news, benchmark listings. No NDA datasheets.
33+
validations:
34+
required: true
35+
- type: checkboxes
36+
id: not_qs
37+
attributes:
38+
label: Scope
39+
options:
40+
- label: This is an engineering sample (ES), not QS and not a retail SKU.
41+
required: true

‎.github/ISSUE_TEMPLATE/data_correction.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: "ES data correction"
2+
description: Correct an existing engineering-sample record
3+
labels: ["data"]
4+
body:
5+
- type: input
6+
id: slug
7+
attributes:
8+
label: Record slug
9+
placeholder: "intel-qxlb"
10+
validations:
11+
required: true
12+
- type: input
13+
id: field
14+
attributes:
15+
label: Field to correct
16+
placeholder: "boost_clock_ghz"
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: correction
21+
attributes:
22+
label: Current value to correct value (with public source)
23+
validations:
24+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "Feature request"
2+
description: Propose a schema, validator, or site change
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: Problem / motivation
9+
validations:
10+
required: true
11+
- type: textarea
12+
id: proposal
13+
attributes:
14+
label: Proposed solution
15+
validations:
16+
required: true
17+
- type: checkboxes
18+
id: scope
19+
attributes:
20+
label: Scope check
21+
options:
22+
- label: This stays ES-only (QS and retail SKUs belong in TechAPI, not here).
23+
required: true

‎.github/pull_request_template.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!-- PR title must follow Conventional Commits, e.g. data(cpu): add Intel QXLB ES -->
2+
3+
## What & why
4+
5+
<!-- What does this change and why? Use "Closes #123" for scoped work issues. Do not close the long-running tracker (#1). -->
6+
7+
## Source
8+
9+
<!-- Public source URLs for ES identification (CPU-World, news, benchmark listings). No NDA material. -->
10+
11+
## Checklist
12+
13+
- [ ] `python -m app.validate` passes locally
14+
- [ ] Record `sample_class` is `es` (QS / retail / production are rejected)
15+
- [ ] Files live at `data/cpu/<manufacturer>/<year>/<segment>/<slug>.json`
16+
- [ ] Slugs are kebab-case and unique
17+
- [ ] `source_urls` cites at least one public reference
18+
- [ ] `qspec` (Intel) and/or `opn` (AMD) is present

‎.github/workflows/deploy-pages.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: deploy-pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: actions/setup-python@v5
23+
with:
24+
python-version: "3.12"
25+
- name: Build static index
26+
run: python site/build.py
27+
- uses: actions/upload-pages-artifact@v3
28+
with:
29+
path: site
30+
31+
deploy:
32+
needs: build
33+
runs-on: ubuntu-latest
34+
environment:
35+
name: github-pages
36+
url: ${{ steps.deployment.outputs.page_url }}
37+
steps:
38+
- id: deployment
39+
uses: actions/deploy-pages@v4

‎.github/workflows/validate-data.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: validate-data
2+
3+
on:
4+
pull_request:
5+
branches: [develop, main]
6+
push:
7+
branches: [develop, main]
8+
9+
jobs:
10+
validate:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: actions/setup-python@v5
15+
with:
16+
python-version: "3.12"
17+
- name: Validate ES catalog
18+
run: python -m app.validate
19+
- name: Tests (ES pass, QS/retail fail)
20+
run: |
21+
python -m pip install pytest
22+
python -m pytest -q

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,6 @@ coverage.xml
3030

3131
# Generated site catalog (rebuilt in CI)
3232
site/catalog.json
33+
34+
# Local GitHub setup helpers (not part of the catalog)
35+
.github-setup/

0 commit comments

Comments
 (0)