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.

Sign up for GitHub

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

Add missing nodes typing for docs #606

Merged
merged 2 commits into from
May 17, 2023
Merged

Add missing nodes typing for docs #606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42ac289
fix: missing nodes typing for docs
skjnldsv May 17, 2023
176e8c9
feat: test docs build on pull requests
skjnldsv May 17, 2023
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
23 changes: 13 additions & 10 deletions .github/workflows/doc-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,33 @@
name: Doc Publish
name: Documentation

on:
pull_request:
release:
types: [published]

jobs:
publish:
build-and-deploy:
runs-on: ubuntu-latest

name: Publish doc
name: Build and deploy
steps:
- name: Check actor permission level
uses: skjnldsv/check-actor-permission@v2
uses: skjnldsv/check-actor-permission@e591dbfe838300c007028e1219ca82cc26e8d7c5 # v2
with:
require: admin

- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3

- name: Read package.json node and npm engines version
uses: skjnldsv/read-package-engines-version-actions@v1.2
uses: skjnldsv/read-package-engines-version-actions@0ce2ed60f6df073a62a77c0a4958dd0fc68e32e7 # v2.1
id: versions
with:
fallbackNode: '^16'
fallbackNpm: '^8'

- name: Set up node ${{ steps.versions.outputs.nodeVersion }}
uses: actions/setup-node@v2
uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # v3
with:
node-version: ${{ steps.versions.outputs.nodeVersion }}

Expand All @@ -36,11 +37,13 @@ jobs:
- name: Install dependencies & build
run: |
npm ci
npm run build
npm run build:doc
npm run build --if-present
npm run build:doc --if-present

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
# Only deploy on release
if: github.event.release
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test release deploy:

uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./dist/doc
15 changes: 7 additions & 8 deletions package-lock.json
View file
Open in desktop

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

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
"url": "https://github.com/nextcloud/nextcloud-event-bus"
},
"dependencies": {
"@types/node": "^20.1.7",
"semver": "^7.5.1"
},
"devDependencies": {
Expand Down