Skip to content

Commit 189e55d

Browse files
committed
feat: add deploy docs workflow
1 parent 257c958 commit 189e55d

File tree

4 files changed

+73
-10
lines changed

4 files changed

+73
-10
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
name: CI
2+
23
on:
34
push:
45
branches:

.github/workflows/deploy-docs.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
workflow_dispatch:
12+
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
concurrency:
19+
group: pages
20+
cancel-in-progress: false
21+
22+
jobs:
23+
# Build job
24+
build:
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v4
29+
with:
30+
fetch-depth: 0 # Not needed if lastUpdated is not enabled
31+
- name: Setup
32+
uses: ./.github/actions/setup
33+
34+
- name: Setup Pages
35+
uses: actions/configure-pages@v5
36+
37+
- name: Install dependencies
38+
working-directory: /docs
39+
run: yarn install
40+
41+
- name: Build with Rspress
42+
working-directory: /docs
43+
run: |
44+
yarn run build
45+
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: docs/doc_build
50+
51+
# Deployment job
52+
deploy:
53+
environment:
54+
name: github-pages
55+
url: ${{ steps.deployment.outputs.page_url }}
56+
needs: build
57+
runs-on: ubuntu-latest
58+
name: Deploy
59+
steps:
60+
- name: Deploy to GitHub Pages
61+
id: deployment
62+
uses: actions/deploy-pages@v4

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "rspress-doc-template",
2+
"name": "react-native-bottom-tabs-docs",
33
"version": "1.0.0",
44
"private": true,
55
"scripts": {

yarn.lock

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13516,6 +13516,15 @@ __metadata:
1351613516
languageName: node
1351713517
linkType: hard
1351813518

13519+
"react-native-bottom-tabs-docs@workspace:docs":
13520+
version: 0.0.0-use.local
13521+
resolution: "react-native-bottom-tabs-docs@workspace:docs"
13522+
dependencies:
13523+
"@types/node": ^16
13524+
rspress: ^1.31.1
13525+
languageName: unknown
13526+
linkType: soft
13527+
1351913528
"react-native-bottom-tabs-example@workspace:example":
1352013529
version: 0.0.0-use.local
1352113530
resolution: "react-native-bottom-tabs-example@workspace:example"
@@ -14459,15 +14468,6 @@ __metadata:
1445914468
languageName: node
1446014469
linkType: hard
1446114470

14462-
"rspress-doc-template@workspace:docs":
14463-
version: 0.0.0-use.local
14464-
resolution: "rspress-doc-template@workspace:docs"
14465-
dependencies:
14466-
"@types/node": ^16
14467-
rspress: ^1.31.1
14468-
languageName: unknown
14469-
linkType: soft
14470-
1447114471
"rspress@npm:^1.31.1":
1447214472
version: 1.32.0
1447314473
resolution: "rspress@npm:1.32.0"

0 commit comments

Comments
 (0)