Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add docs generation #43

Merged
merged 44 commits into from
Jan 27, 2025
Merged
Changes from 1 commit
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
486a30f
add docs generation
onnovisser Jan 13, 2025
e8ba866
[bot] New pkg version: 0.0.0-alpha.6
actions-user Jan 13, 2025
6ca9ccf
Test docs automation
sophialittlejohn Jan 13, 2025
eadf434
Force yarn@stable in workflow
sophialittlejohn Jan 13, 2025
4a05f36
Try setting stable version manually
sophialittlejohn Jan 13, 2025
d825475
Update order
sophialittlejohn Jan 13, 2025
07bed06
Install deps before gen:docs
sophialittlejohn Jan 13, 2025
2f5fb40
Add user to github
sophialittlejohn Jan 13, 2025
ef531bd
Convert script to cjs file
sophialittlejohn Jan 13, 2025
095efe0
Update clone url
sophialittlejohn Jan 13, 2025
5b6fde1
Add org name
sophialittlejohn Jan 13, 2025
c313385
Remove docs
sophialittlejohn Jan 14, 2025
1c2f461
Checkout branch later
sophialittlejohn Jan 14, 2025
20104b1
Update docs
actions-user Jan 14, 2025
20f6f74
Login to github
sophialittlejohn Jan 14, 2025
60a8a25
Update docs
actions-user Jan 14, 2025
fef7676
Use PAT token to allow pushing to repo
sophialittlejohn Jan 14, 2025
d97b7f1
Use auth url
sophialittlejohn Jan 14, 2025
20843ed
oauth for authorization
sophialittlejohn Jan 14, 2025
c380e23
Update docs
actions-user Jan 14, 2025
8477ffd
Regular auth?
sophialittlejohn Jan 14, 2025
53d1140
Fix naming
sophialittlejohn Jan 14, 2025
f6a84e5
Update docs
actions-user Jan 14, 2025
06481dd
Exclude readme and improve copy
sophialittlejohn Jan 14, 2025
2da740f
[ci:bot] Update docs
actions-user Jan 14, 2025
5924ed5
Unique branch names and earlier auth
sophialittlejohn Jan 14, 2025
e6c77e4
[ci:bot] Update docs
actions-user Jan 14, 2025
212732e
Fix branch name
sophialittlejohn Jan 14, 2025
da56da0
[ci:bot] Update docs
actions-user Jan 14, 2025
f4a0555
Exclude readme in typedoc generation
sophialittlejohn Jan 14, 2025
7cb1f39
[ci:bot] Update docs
actions-user Jan 14, 2025
862f7f1
Exclude _globals.md
sophialittlejohn Jan 14, 2025
95301cd
[ci:bot] Update docs
actions-user Jan 14, 2025
ae12cdc
Fix typo
sophialittlejohn Jan 14, 2025
34d731a
[ci:bot] Update docs
actions-user Jan 14, 2025
79d4569
Add note in readme and switch trigger branch to main
sophialittlejohn Jan 14, 2025
63f931b
Exclude docs from test coverage
sophialittlejohn Jan 15, 2025
25fd692
Improve script to handle updating index.html.md and deleting old files
sophialittlejohn Jan 15, 2025
e8e313e
Update target for testing
sophialittlejohn Jan 15, 2025
45d9bb1
[ci:bot] Update docs
actions-user Jan 15, 2025
216f00e
Test deployment without pushing docs/ folder
sophialittlejohn Jan 15, 2025
89e29cf
Move diff check into script
sophialittlejohn Jan 15, 2025
10098ef
Merge branch 'main' of github.com:centrifuge/centrifuge-sdk into gene…
sophialittlejohn Jan 27, 2025
c3c67a4
Disable workflow
sophialittlejohn Jan 27, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update order
  • Loading branch information
sophialittlejohn committed Jan 13, 2025
commit d825475d6ca9f0ff790daf5926420077868c166d
23 changes: 10 additions & 13 deletions .github/workflows/update-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ jobs:
- name: Checkout the repo
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Setup Yarn
run: |
corepack enable
corepack prepare yarn@4.5.0 --activate

- name: Run the gen:docs command
run: yarn gen:docs

Expand All @@ -32,19 +42,6 @@ jobs:
if: steps.commit_check.outputs.has_changes == 'true'
run: git push

- name: Setup Node.js
if: steps.commit_check.outputs.has_changes == 'true'
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Setup Yarn
if: steps.commit_check.outputs.has_changes == 'true'
run: |
corepack enable
corepack prepare yarn@stable --activate
yarn set version stable

- name: Install dependencies
if: steps.commit_check.outputs.has_changes == 'true'
run: yarn add simple-git
Expand Down
Loading