Skip to content

Commit

Permalink
fix(gh-action): build-and-deploy should first build core before build…
Browse files Browse the repository at this point in the history
…ing OpenSCD (#1427)

* fix(gh-action): build-and-deploy should first build core before building openscd

* Update README.md
  • Loading branch information
pascalwilbrink committed Jan 29, 2024
1 parent 43b8285 commit e25e5f8
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
18 changes: 13 additions & 5 deletions .github/workflows/build-and-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ on:
jobs:
build-and-deploy:
runs-on: ubuntu-latest
defaults:
run:
shell: bash
working-directory: packages/open-scd
steps:
- name: Checkout
uses: actions/checkout@v2.3.1
Expand All @@ -22,10 +18,22 @@ jobs:
with:
node-version: '18.x'

- name: Install and Build
- name: Install and build Core
run: |
cd packages/core
npm clean-install
npm run-script build
npm run-script doc
- name: Install and Build OpenSCD
run: |
cd packages/open-scd
npm clean-install
npm run-script build
- name: Copy Core Docs to OpenSCD
run: |
cp -R packages/core/doc packages/open-scd/build/core-doc
- name: Deploy
uses: JamesIves/github-pages-deploy-action@4.1.5
Expand Down
2 changes: 1 addition & 1 deletion packages/open-scd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This will start a local development server and open a browser window which will

### TypeDoc

This project uses [TypeDoc](https://typedoc.org/) to transform documentation comments in the source code into a rendered HTML document that can be queried and navigated through. If you want to consult the generated documentation for the TypeScript components, mixins, modules and other relevant artifacts of this project, you can [do it here](https://openscd.github.io/doc/).
This project uses [TypeDoc](https://typedoc.org/) to transform documentation comments in the source code into a rendered HTML document that can be queried and navigated through. If you want to consult the generated documentation for the TypeScript components, mixins, modules and other relevant artifacts of this project, you can [do it here](https://openscd.github.io/doc/). Documentation for OpenSCD Core [can be found here](https://openscd.github.io/core-doc).

### Linting & Formatting

Expand Down

0 comments on commit e25e5f8

Please sign in to comment.