Skip to content

Commit b13558a

Browse files
Jack-Keenegreg-el
authored andcommitted
Host Javascript API docs (close #1255)
PR #1256 * Add docs workflow * Remove old docs folder * Update publish workflow
1 parent ee07554 commit b13558a

File tree

346 files changed

+15271
-19
lines changed

Some content is hidden

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

346 files changed

+15271
-19
lines changed

.github/workflows/docs.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
workflow_run:
5+
workflows: ['Deploy Tracker']
6+
types:
7+
- completed
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
deploy:
13+
name: Deploy to GitHub Pages
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
- uses: actions/setup-node@v3
18+
with:
19+
node-version: 18
20+
21+
- name: Install dependencies
22+
working-directory: ./api-docs
23+
run: npm install
24+
- name: Build website
25+
working-directory: ./api-docs
26+
run: npm run build
27+
- name: Deploy to GitHub Pages
28+
uses: peaceiris/actions-gh-pages@v3
29+
with:
30+
github_token: ${{ secrets.GITHUB_TOKEN }}
31+
publish_dir: ./api-docs/build

.github/workflows/publish.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,18 +67,18 @@ jobs:
6767
working-directory: ./trackers/browser-tracker
6868
run: |
6969
api-extractor run
70-
api-documenter markdown --input-folder temp --output-folder docs/markdown
70+
api-documenter markdown --input-folder temp --output-folder ../../api-docs/docs/browser-tracker/markdown
7171
7272
- name: Create API documentation for @snowplow/node-tracker
7373
working-directory: ./trackers/node-tracker
7474
run: |
7575
api-extractor run
76-
api-documenter markdown --input-folder temp --output-folder docs/markdown
76+
api-documenter markdown --input-folder temp --output-folder ../../api-docs/docs/node-tracker/markdown
7777
7878
- name: Apply API documentation updates
7979
run: |
80-
git add trackers/browser-tracker/docs
81-
git add trackers/node-tracker/docs
80+
git add api-docs/docs/browser-tracker
81+
git add api-docs/docs/node-tracker
8282
git commit --no-verify --allow-empty -m "Applying documentation updates."
8383
git push
8484

api-docs/.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

api-docs/babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

0 commit comments

Comments
 (0)