Skip to content

Commit

Permalink
fix: set up tsdoc-markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
faergeek committed Feb 7, 2024
1 parent b6b5928 commit 37f7a5d
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .github/workflows/tsdoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: tsdoc-markdown
on: [pull_request]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
tsdoc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.event.pull_request.head.ref }}
- uses: pnpm/action-setup@v2
- uses: actions/setup-node@v4
with:
cache: pnpm
node-version-file: .nvmrc
- run: pnpm install --frozen-lockfile
- run: pnpm run tsdoc
- uses: EndBug/add-and-commit@v9
with:
add: .
default_author: github_actions
message: '🤖 Documentation auto-update'
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# @faergeek/monads

Easy to use monads for JavaScript and TypeScript

<!-- TSDOC_START -->
<!-- TSDOC_END -->
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@
"lint": "eslint --max-warnings 0 .",
"typecheck": "tsc -p tsconfig.node.json --noEmit",
"test": "vitest",
"build": "tsc"
"build": "tsc",
"tsdoc": "tsdoc --src='src/*'"
},
"packageManager": "[email protected]",
"devDependencies": {
Expand All @@ -39,6 +40,7 @@
"prettier": "^3.2.5",
"rimraf": "^5.0.5",
"semantic-release": "^23.0.2",
"tsdoc-markdown": "^0.1.0",
"typescript": "^5.3.3",
"vitest": "^1.2.2"
}
Expand Down
12 changes: 12 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 37f7a5d

Please sign in to comment.