-
Notifications
You must be signed in to change notification settings - Fork 233
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a PR template and typedoc site generation (#83)
* Add a PR template and typedoc site generation * Update the CLA list
- Loading branch information
Showing
3 changed files
with
37 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
## What it solves | ||
Resolves # | ||
|
||
## How this PR fixes it |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
name: typedoc | ||
|
||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
typedoc: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v2 | ||
|
||
- run: npm install | ||
|
||
- run: npm run build | ||
|
||
- run: npm install typescript typedoc | ||
|
||
- name: Create the docs directory locally in CI | ||
run: ./node_modules/.bin/typedoc --tsconfig packages/safe-core-sdk/tsconfig.json packages/safe-core-sdk/src | ||
|
||
- name: Deploy 🚀 | ||
uses: JamesIves/github-pages-deploy-action@4.1.4 | ||
with: | ||
branch: gh-pages | ||
folder: docs |