Skip to content

Commit

Permalink
Add a PR template and typedoc site generation (#83)
Browse files Browse the repository at this point in the history
* Add a PR template and typedoc site generation

* Update the CLA list
  • Loading branch information
katspaugh authored Oct 5, 2021
1 parent 3c773bc commit d5a6e5f
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## What it solves
Resolves #

## How this PR fixes it
4 changes: 2 additions & 2 deletions .github/workflows/cla.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ jobs:
path-to-signatures: 'signatures/version1/cla.json'
path-to-cla-document: 'https://gnosis-safe.io/cla/'
branch: 'cla-signatures'
allowlist: germartinez,mikheevm,rmeissner,Uxio0,dasanra,davidalbela,luarx,giacomolicari,lukasschor,tschubotz,gnosis-info,bot*
allowlist: germartinez,mikheevm,rmeissner,Uxio0,dasanra,davidalbela,luarx,giacomolicari,lukasschor,tschubotz,gnosis-info,bot*,katspaugh
empty-commit-flag: false
blockchain-storage-flag: false
blockchain-storage-flag: false
31 changes: 31 additions & 0 deletions .github/workflows/typedoc.yml
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

0 comments on commit d5a6e5f

Please sign in to comment.