Skip to content

Commit dbde5ce

Browse files
Merge remote-tracking branch 'origin/master'
2 parents 9ebad65 + 4d980c9 commit dbde5ce

119 files changed

Lines changed: 9779 additions & 1270 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: Build and Deploy documentation to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
build:
13+
name: Generate docs content
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout Repository
18+
uses: actions/checkout@v4
19+
20+
- name: Setup Flutter
21+
uses: subosito/flutter-action@v2
22+
with:
23+
channel: 'stable'
24+
25+
- name: Install Dependencies
26+
run: dart pub get
27+
28+
- name: Generate documentation files
29+
run: >
30+
dart run bin/generate_web_docs_content.dart
31+
--path lib/src/lints
32+
--docs-dir doc/docusaurus/docs/2_custom_lints
33+
--readme README.md
34+
35+
- name: Create generated docs artifact
36+
uses: actions/upload-artifact@v4
37+
with:
38+
name: generated-docs
39+
path: doc/docusaurus/docs
40+
41+
deploy:
42+
needs: build
43+
name: Deploy to GitHub Pages
44+
runs-on: ubuntu-latest
45+
defaults:
46+
run:
47+
working-directory: doc/docusaurus
48+
49+
permissions:
50+
pages: write
51+
id-token: write
52+
53+
environment:
54+
name: github-pages
55+
url: ${{ steps.deployment.outputs.page_url }}
56+
57+
steps:
58+
- uses: actions/checkout@v4
59+
with:
60+
fetch-depth: 0
61+
62+
- uses: actions/setup-node@v4
63+
with:
64+
node-version: 18
65+
cache: yarn
66+
cache-dependency-path: doc/docusaurus/yarn.lock
67+
68+
- name: Install dependencies
69+
run: yarn install --frozen-lockfile
70+
71+
- name: Download generated docs
72+
uses: actions/download-artifact@v4
73+
with:
74+
name: generated-docs
75+
path: doc/docusaurus/docs
76+
77+
- name: Build website
78+
run: yarn build
79+
80+
- name: Setup Pages
81+
uses: actions/configure-pages@v3
82+
83+
- name: Upload Artifact
84+
uses: actions/upload-pages-artifact@v1
85+
with:
86+
path: doc/docusaurus/build
87+
88+
- name: Deploy to GitHub Pages
89+
id: deployment
90+
uses: actions/deploy-pages@v2

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1+
## 0.1.2
2+
3+
- Moved implementation into the `src` folder
4+
15
## 0.1.1
26

3-
-Add example readme
4-
-Update dependencies
7+
- Add example readme
8+
- Update dependencies
59

610
## 0.1.0
711

0 commit comments

Comments
 (0)