Skip to content

Commit 8068839

Browse files
petercrockerpetercrocker
committed
add docusaurus
1 parent 166678c commit 8068839

File tree

88 files changed

+24921
-803
lines changed

Some content is hidden

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

88 files changed

+24921
-803
lines changed

‎.github/build-docs.sh‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/sh
2+
3+
cd docs && npm install && npm run build

‎.github/labeler.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
"group/ci":
3+
- changed-files:
4+
- any-glob-to-any-file: [".github/**"]
5+
6+
"type/documentation":
7+
- changed-files:
8+
- any-glob-to-any-file: ["docs/**"]

‎.github/labels.yml‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
# Labels names are important as they are used by Release Drafter to decide
3+
# regarding where to record them in changelog or if to skip them.
4+
#
5+
# The repository labels will be automatically configured using this file and
6+
# the GitHub Action https://github.com/marketplace/actions/github-labeler.
7+
8+
# ----------------------------------
9+
# GROUP
10+
# ----------------------------------
11+
- name: "group/ci"
12+
description: "Issue related to the CI pipeline"
13+
color: "f25009"
14+
15+
# ----------------------------------
16+
# TYPE (default)
17+
# ----------------------------------
18+
- name: "type/feature"
19+
description: "New feature or request"
20+
color: "a2eeef"
21+
22+
- name: "type/bug"
23+
description: "Something isn't working as expected"
24+
color: "d73a4a"
25+
26+
- name: "type/housekeeping"
27+
description: "Maintenance task"
28+
color: "fef2c0"
29+
30+
- name: "type/tech-debt"
31+
description: "Item we know we need to improve way it is implemented"
32+
color: "73FA20"
33+
34+
# ----------------------------------
35+
# TYPE ALL
36+
# ----------------------------------
37+
- name: "type/question"
38+
description: "Question or discussion"
39+
color: "d876e3"
40+
41+
- name: "type/documentation"
42+
description: "Improvements or additions to documentation"
43+
color: "0075ca"
44+
45+
- name: "type/duplicate"
46+
description: "This issue or pull request already exists"
47+
color: "cfd3d7"
48+
49+
- name: "type/epic"
50+
description: "Large body of work composed of multiple tasks and/or features"
51+
color: "fbd39c"
52+
53+
- name: "type/task"
54+
description: "Body of work related to an epic"
55+
color: "0b8e92"
56+
57+
- name: "type/brainstorming"
58+
description: "Topic for brainstorming, discussions"
59+
color: "e19e0f"
60+
61+
- name: "type/user-centric"
62+
description: "Issue that would improve the overall experience of our users"
63+
color: "ff8c00"
64+
65+
- name: "type/newcomers"
66+
description: "Good for newcomers"
67+
color: "309c56"
68+
69+
# ----------------------------------
70+
# EFFORT
71+
# ----------------------------------
72+
- name: "effort/high"
73+
description: "This issue should be completed in more than a day"
74+
color: "b60205"
75+
76+
- name: "effort/medium"
77+
description: "This issue should be completed in a less than a day"
78+
color: "ff9f1c"
79+
80+
- name: "effort/low"
81+
description: "This issue should be completed in a couple of hours"
82+
color: "ffcc00"
83+
84+
# ----------------------------------
85+
# SEVERITY
86+
# ----------------------------------
87+
- name: "priority/1"
88+
description: "This issue must be fixed/implemented ASAP, it's a blocker for a release"
89+
color: "b60205"
90+
91+
- name: "priority/2"
92+
description: "This issue stalls work on the project or its dependents, it's a blocker for a release"
93+
color: "ff9f1c"
94+
95+
- name: "priority/3"
96+
description: "Not blocking but should be fixed soon"
97+
color: "ffcc00"
98+
99+
- name: "priority/4"
100+
description: "Low priority and doesn't need to be rushed"
101+
color: "cfda2c"
102+
103+
# ----------------------------------
104+
# STATUS
105+
# ----------------------------------
106+
- name: "state/blocked"
107+
description: "The issue is currently blocked and cannot be resolved."
108+
color: "e34918"
109+
110+
- name: "state/draft"
111+
description: "The redaction of the issue is still a work in progress"
112+
color: "dcb518"
113+
114+
- name: "state/need-triage"
115+
description: "This issue needs to be triaged"
116+
color: "333333"
117+
118+
- name: "state/need-more-info"
119+
description: "This issue needs more information"
120+
color: "cccccc"
121+
122+
- name: "state/need-testing"
123+
description: "This issue is ready and needs to be tested."
124+
color: "cccccc"
125+
126+
- name: "state/backlog"
127+
description: "This issue is part of the backlog"
128+
color: "eeeeee"
129+
130+
- name: "state/planned"
131+
description: "This issue is planned to be worked on in an upcoming release."
132+
color: "eeeeee"
133+
134+
- name: "state/not-reproducible"
135+
description: "Unable to reproduce this issue."
136+
color: "eeeeee"
137+
138+
- name: "state/wont-fix"
139+
description: "Issue has been closed and won't be fix/implemented."
140+
color: "eeeeee"

‎.github/workflows/ci.yml‎

Lines changed: 108 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,69 @@ concurrency:
1313

1414
env:
1515
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
16+
VALE_VERSION: "3.7.1"
1617

1718
jobs:
1819
files-changed:
1920
name: Detect which file has changed
2021
runs-on: ubuntu-latest
2122
timeout-minutes: 5
2223
outputs:
24+
documentation: ${{ steps.changes.outputs.documentation_all }}
25+
python: ${{ steps.changes.outputs.python_all }}
2326
yaml: ${{ steps.changes.outputs.yaml_all }}
2427
steps:
2528
- name: "Check out repository code"
2629
uses: "actions/checkout@v4"
2730
- name: Check for file changes
28-
uses: dorny/paths-filter@v3
31+
uses: opsmill/paths-filter@v3.0.2
2932
id: changes
3033
with:
3134
token: ${{ github.token }}
3235
filters: .github/file-filters.yml
3336

37+
python-lint:
38+
if: needs.files-changed.outputs.python == 'true'
39+
needs: ["files-changed"]
40+
runs-on: "ubuntu-latest"
41+
strategy:
42+
matrix:
43+
python-version:
44+
- "3.12"
45+
poetry-version:
46+
- "1.8.5"
47+
timeout-minutes: 5
48+
steps:
49+
- name: "Check out repository code"
50+
uses: "actions/checkout@v4"
51+
52+
- name: "Set up Python ${{ matrix.python-version }}"
53+
uses: "actions/setup-python@v5"
54+
with:
55+
python-version: ${{ matrix.python-version }}
56+
- name: "Install Poetry ${{ matrix.poetry-version }}"
57+
uses: "snok/install-poetry@v1"
58+
with:
59+
version: ${{ matrix.poetry-version }}
60+
virtualenvs-create: true
61+
virtualenvs-in-project: true
62+
installer-parallel: true
63+
- name: "Setup Python environment"
64+
run: |
65+
poetry config virtualenvs.create true --local
66+
poetry env use ${{ matrix.python-version }}
67+
- name: "Install dependencies"
68+
run: "poetry install --no-interaction --no-ansi --with dev"
69+
70+
- name: "Linting: ruff check"
71+
run: "poetry run ruff check ."
72+
- name: "Linting: ruff format"
73+
run: "poetry run ruff format --check --diff ."
74+
- name: "Mypy Tests"
75+
run: "poetry run mypy --show-error-codes emma pages"
76+
- name: "Pylint Tests"
77+
run: "poetry run pylint . *.py"
78+
3479
yaml-lint:
3580
name: Run yaml lint
3681
if: needs.files-changed.outputs.yaml == 'true'
@@ -45,7 +90,6 @@ jobs:
4590
- name: "Linting: yamllint"
4691
run: "yamllint -s ."
4792

48-
# FIXME: This should be triggered only when some YAML schema changes...
4993
schema-test:
5094
name: Test all schema files
5195
needs:
@@ -54,7 +98,9 @@ jobs:
5498
if: |
5599
always() && !cancelled() &&
56100
!contains(needs.*.result, 'failure') &&
57-
!contains(needs.*.result, 'cancelled')
101+
!contains(needs.*.result, 'cancelled') &&
102+
needs.files-changed.outputs.yaml == 'true'
103+
58104
runs-on:
59105
group: huge-runners
60106
env:
@@ -81,7 +127,7 @@ jobs:
81127
run: echo INFRAHUB_BUILD_NAME=infrahub-${{ runner.name }} >> $GITHUB_ENV
82128

83129
- name: Initialize Infrahub
84-
run: invoke start
130+
run: invoke schemas.start
85131

86132
- name: Set infrahub address
87133
run: |
@@ -92,11 +138,67 @@ jobs:
92138
run: echo TEST_START_TIME=$(date +%s)000 >> $GITHUB_ENV
93139

94140
- name: Test base schema files
95-
run: invoke load-schema-base
141+
run: invoke schemas.load-schema-base
96142

97143
- name: Test extensions schema files
98-
run: invoke load-schema-extensions
144+
run: invoke schemas.load-schema-extensions
99145

100146
- name: "Clear docker environment and force vmagent to stop"
101147
if: always()
102148
run: docker compose -p $INFRAHUB_BUILD_NAME down -v --remove-orphans --rmi local
149+
150+
documentation:
151+
defaults:
152+
run:
153+
working-directory: ./docs
154+
if: |
155+
always() && !cancelled() &&
156+
!contains(needs.*.result, 'failure') &&
157+
!contains(needs.*.result, 'cancelled') &&
158+
needs.files-changed.outputs.documentation == 'true'
159+
needs: ["files-changed", "yaml-lint", "python-lint"]
160+
runs-on: "ubuntu-22.04"
161+
timeout-minutes: 5
162+
steps:
163+
- name: "Check out repository code"
164+
uses: "actions/checkout@v4"
165+
with:
166+
submodules: true
167+
- name: Install NodeJS
168+
uses: actions/setup-node@v4
169+
with:
170+
node-version: 20
171+
cache: 'npm'
172+
cache-dependency-path: docs/package-lock.json
173+
- name: "Install dependencies"
174+
run: npm install
175+
- name: "Setup Python environment"
176+
run: "pip install invoke toml"
177+
- name: "Build docs website"
178+
run: "invoke docusaurus.docs"
179+
180+
validate-documentation-style:
181+
if: |
182+
always() && !cancelled() &&
183+
!contains(needs.*.result, 'failure') &&
184+
!contains(needs.*.result, 'cancelled') &&
185+
needs.files-changed.outputs.documentation == 'true'
186+
needs: ["files-changed", "yaml-lint", "python-lint"]
187+
runs-on: "ubuntu-22.04"
188+
timeout-minutes: 5
189+
steps:
190+
- name: "Check out repository code"
191+
uses: "actions/checkout@v4"
192+
with:
193+
submodules: true
194+
195+
# The official GitHub Action for Vale doesn't work, installing manually instead:
196+
# https://github.com/errata-ai/vale-action/issues/103
197+
- name: Download Vale
198+
run: |
199+
curl -sL "https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz" -o vale.tar.gz
200+
tar -xzf vale.tar.gz
201+
env:
202+
VALE_VERSION: ${{ env.VALE_VERSION }}
203+
- name: "Validate documentation style"
204+
run: ./vale $(find ./docs -type f \( -name "*.mdx" -o -name "*.md" \) )

‎.github/workflows/sync-docs.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Sync Folders
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/docs/**'
9+
- 'docs/sidebars.ts'
10+
11+
jobs:
12+
sync:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout source repository
16+
uses: actions/checkout@v4
17+
with:
18+
path: source-repo
19+
20+
- name: Checkout target repository
21+
uses: actions/checkout@v4
22+
with:
23+
repository: opsmill/infrahub-docs
24+
token: ${{ secrets.PAT_TOKEN }}
25+
path: target-repo
26+
27+
- name: Sync folders
28+
run: |
29+
rm -rf target-repo/docs/docs-schema-library/*
30+
rm -f target-repo/docs/sidebars-schema.ts
31+
cp -r source-repo/docs/docs/* target-repo/docs/docs-schema-library/
32+
cp source-repo/docs/sidebars.ts target-repo/docs/sidebars-schema.ts
33+
cd target-repo
34+
git config user.name github-actions
35+
git config user.email github-actions@github.com
36+
git add .
37+
if ! (git diff --quiet && git diff --staged --quiet); then git commit -m "Sync docs from schema-library repo" && git push; fi

‎.markdownlint.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
default: true
3+
MD007:
4+
indent: 4 # sets indent size to 4 spaces
5+
MD013: false # disables max line-length
6+
MD024: false # disables 'no duplicate headings',
7+
# which we use in tabs for instructions
8+
MD025:
9+
front_matter_title: "" # prevent collisions with h1s
10+
# and frontmatter titles
11+
MD029: false # allows manually creating ordered lists
12+
MD033: false # allows inline html to override markdown styles
13+
MD034: false # no-bare-urls
14+
MD045: false # no alt text around images
15+
MD047: false # single trailing newline
16+
MD014: false # dollar signs used before commands

0 commit comments

Comments
 (0)