Skip to content

Commit 12f21d5

Browse files
docs deployment
1 parent 0a5ea1b commit 12f21d5

File tree

4 files changed

+91
-9
lines changed

4 files changed

+91
-9
lines changed

.github/workflows/docs-deploy.yaml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
jobs:
11+
build:
12+
name: Build Docusaurus
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
- uses: actions/setup-node@v4
19+
with:
20+
node-version: 18
21+
22+
- name: Install dependencies
23+
run: cd docs && yarn install --frozen-lockfile
24+
- name: Build website
25+
run: cd docs && yarn build
26+
27+
- name: Upload Build Artifact
28+
uses: actions/upload-pages-artifact@v3
29+
with:
30+
path: docs/build
31+
32+
deploy:
33+
name: Deploy to GitHub Pages
34+
needs: build
35+
36+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
37+
permissions:
38+
pages: write # to deploy to Pages
39+
id-token: write # to verify the deployment originates from an appropriate source
40+
41+
# Deploy to the github-pages environment
42+
environment:
43+
name: github-pages
44+
url: ${{ steps.deployment.outputs.page_url }}
45+
46+
runs-on: ubuntu-latest
47+
steps:
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@v4
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Test deployment
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
jobs:
11+
test-deploy:
12+
name: Test deployment
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
- uses: actions/setup-node@v4
19+
working-directory: ./docs
20+
with:
21+
node-version: 18
22+
cache: yarn
23+
24+
- name: Install dependencies
25+
working-directory: ./docs
26+
run: yarn install --frozen-lockfile
27+
- name: Test build website
28+
working-directory: ./docs
29+
run: yarn build

docs/docusaurus.config.ts

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ const config: Config = {
1010
favicon: "img/favicon.ico",
1111

1212
// Set the production url of your site here
13-
url: "https://your-docusaurus-site.example.com",
13+
url: "https://peersyst.github.io",
1414
// Set the /<baseUrl>/ pathname under which your site is served
1515
// For GitHub pages deployment, it is often '/<projectName>/'
16-
baseUrl: "/",
16+
baseUrl: "/1-click-connect",
1717

1818
// GitHub pages deployment config.
1919
// If you aren't using GitHub pages, you don't need these.
@@ -23,6 +23,9 @@ const config: Config = {
2323
onBrokenLinks: "throw",
2424
onBrokenMarkdownLinks: "warn",
2525

26+
deploymentBranch: "gh-pages",
27+
trailingSlash: false,
28+
2629
// Even if you don't use internationalization, you can use this field to set
2730
// useful metadata like html lang. For example, if your site is Chinese, you
2831
// may want to replace "en" with "zh-Hans".
@@ -109,12 +112,12 @@ const config: Config = {
109112
},
110113
],
111114
},
112-
{
113-
type: "docSidebar",
114-
sidebarId: "changeLogSidebar",
115-
position: "left",
116-
label: "Changelog",
117-
},
115+
// {
116+
// type: "docSidebar",
117+
// sidebarId: "changeLogSidebar",
118+
// position: "left",
119+
// label: "Changelog",
120+
// },
118121
{
119122
href: "https://github.com/Peersyst/one-click-connect",
120123
label: "GitHub",

packages/wallet/vanilla/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@one-click-connect/wallet-vanilla",
2+
"name": "@one-click-connect/wallet",
33
"version": "0.1.0-alpha.0",
44
"scripts": {
55
"build": "npx tsc",

0 commit comments

Comments
 (0)