zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/.github/workflows/generate-website.yml

36 lines
919 B
YAML
Raw Normal View History

docs: build the user documentation with Docusaurus (#264) Initiate the website with Docusaurus v3. Setup the site and includes the content that was already available in the `docs` package. The currently implementation mainly uses the default theme available when using the Docusaurus scaffolding. It was initiated with: `npx create-docusaurus@3.0.0 my-website classic`
2023-11-27 17:53:52 +00:00
name: Generate website
refactor(docs): move all docs sources to a dedicated docs package (#168) Keep the former mxGraph documentation to allow a later documentation migration. Remove both the former mxGraph and the new maxGraph API docs as they can be generated. Remove the former mxGraph examples home page as it has been replaced by Storybook. Update the configuration to generate the maxGraph API docs - remove jsdoc resources as it is not used anymore - configure the core package to generate the API docs in the docs package - add a GitHub workflow to ensure we can generate the API docs without errors
2023-01-09 15:03:52 +00:00
on:
pull_request:
branches:
- development
paths:
ci: update modified files that trigger workflow execution (#280) Some recently deleted files were still listed, while the package-lock.json file had not been added.
2023-12-04 03:13:32 +00:00
- '.github/actions/build-setup/**/*'
docs: build the user documentation with Docusaurus (#264) Initiate the website with Docusaurus v3. Setup the site and includes the content that was already available in the `docs` package. The currently implementation mainly uses the default theme available when using the Docusaurus scaffolding. It was initiated with: `npx create-docusaurus@3.0.0 my-website classic`
2023-11-27 17:53:52 +00:00
- '.github/workflows/generate-website.yml'
chore: build with Node 18 (#263)
2023-11-16 13:39:08 +00:00
- '.nvmrc'
docs: improve the migration guide from mxGraph (#271) Provide various improvements - fix `InternalEvent` - improve `Client` - improve explanations about plugins - removed `mxUtils` methods - removed `isVisible` methods Also use more admonitions.
2023-12-03 23:57:50 +00:00
- 'packages/core/**/*'
- 'packages/website/**/*'
- '!packages/website/README.md'
refactor(docs): move all docs sources to a dedicated docs package (#168) Keep the former mxGraph documentation to allow a later documentation migration. Remove both the former mxGraph and the new maxGraph API docs as they can be generated. Remove the former mxGraph examples home page as it has been replaced by Storybook. Update the configuration to generate the maxGraph API docs - remove jsdoc resources as it is not used anymore - configure the core package to generate the API docs in the docs package - add a GitHub workflow to ensure we can generate the API docs without errors
2023-01-09 15:03:52 +00:00
- 'package.json'
ci: update modified files that trigger workflow execution (#280) Some recently deleted files were still listed, while the package-lock.json file had not been added.
2023-12-04 03:13:32 +00:00
- 'package-lock.json'
- 'tsconfig.json'
refactor(docs): move all docs sources to a dedicated docs package (#168) Keep the former mxGraph documentation to allow a later documentation migration. Remove both the former mxGraph and the new maxGraph API docs as they can be generated. Remove the former mxGraph examples home page as it has been replaced by Storybook. Update the configuration to generate the maxGraph API docs - remove jsdoc resources as it is not used anymore - configure the core package to generate the API docs in the docs package - add a GitHub workflow to ensure we can generate the API docs without errors
2023-01-09 15:03:52 +00:00
jobs:
build:
runs-on: ubuntu-22.04
steps:
chore(deps-gha): bump actions/checkout from 3 to 4 (#240)
2023-09-11 06:58:05 +00:00
- uses: actions/checkout@v4
chore: use npm workspaces (#273) `maxGraph` was using `lerna` v4 to build and only used its "build workspaces" support, not the "publishing" support as we only published a single package and it is done manually, without using `lerna`. The support for packages in `lerna` was removed in version 7. See https://github.com/lerna/lerna/releases/tag/7.0.0 and https://lerna.js.org/docs/legacy-package-management. So, start using npm workspaces as we don't need to manage the publishing of several packages for now. This will allow to do more reproducible builds by locking dependencies with a `package-lock.json` file. This didn't work well with `lerna` v4 and had been disabled.
2023-12-04 02:25:41 +00:00
- name: Build Setup
uses: ./.github/actions/build-setup
refactor(docs): move all docs sources to a dedicated docs package (#168) Keep the former mxGraph documentation to allow a later documentation migration. Remove both the former mxGraph and the new maxGraph API docs as they can be generated. Remove the former mxGraph examples home page as it has been replaced by Storybook. Update the configuration to generate the maxGraph API docs - remove jsdoc resources as it is not used anymore - configure the core package to generate the API docs in the docs package - add a GitHub workflow to ensure we can generate the API docs without errors
2023-01-09 15:03:52 +00:00
- name: Build @maxgraph/core API docs
chore: use npm workspaces (#273) `maxGraph` was using `lerna` v4 to build and only used its "build workspaces" support, not the "publishing" support as we only published a single package and it is done manually, without using `lerna`. The support for packages in `lerna` was removed in version 7. See https://github.com/lerna/lerna/releases/tag/7.0.0 and https://lerna.js.org/docs/legacy-package-management. So, start using npm workspaces as we don't need to manage the publishing of several packages for now. This will allow to do more reproducible builds by locking dependencies with a `package-lock.json` file. This didn't work well with `lerna` v4 and had been disabled.
2023-12-04 02:25:41 +00:00
run: npm run docs:api -w packages/core
docs: build the user documentation with Docusaurus (#264) Initiate the website with Docusaurus v3. Setup the site and includes the content that was already available in the `docs` package. The currently implementation mainly uses the default theme available when using the Docusaurus scaffolding. It was initiated with: `npx create-docusaurus@3.0.0 my-website classic`
2023-11-27 17:53:52 +00:00
- name: Build website
chore: use npm workspaces (#273) `maxGraph` was using `lerna` v4 to build and only used its "build workspaces" support, not the "publishing" support as we only published a single package and it is done manually, without using `lerna`. The support for packages in `lerna` was removed in version 7. See https://github.com/lerna/lerna/releases/tag/7.0.0 and https://lerna.js.org/docs/legacy-package-management. So, start using npm workspaces as we don't need to manage the publishing of several packages for now. This will allow to do more reproducible builds by locking dependencies with a `package-lock.json` file. This didn't work well with `lerna` v4 and had been disabled.
2023-12-04 02:25:41 +00:00
run: npm run build -w packages/website
docs: build the user documentation with Docusaurus (#264) Initiate the website with Docusaurus v3. Setup the site and includes the content that was already available in the `docs` package. The currently implementation mainly uses the default theme available when using the Docusaurus scaffolding. It was initiated with: `npx create-docusaurus@3.0.0 my-website classic`
2023-11-27 17:53:52 +00:00
- name: Upload website artifact
chore(deps-gha): bump actions/upload-artifact from 3 to 4 (#291) Also update the name of the artifact by using a dedicated name per OS With actions/upload-artifact@v4, it is not possible to upload to the same named Artifact multiple times.
2023-12-18 14:54:31 +00:00
uses: actions/upload-artifact@v4
docs: build the user documentation with Docusaurus (#264) Initiate the website with Docusaurus v3. Setup the site and includes the content that was already available in the `docs` package. The currently implementation mainly uses the default theme available when using the Docusaurus scaffolding. It was initiated with: `npx create-docusaurus@3.0.0 my-website classic`
2023-11-27 17:53:52 +00:00
with:
name: website-${{github.sha}}
path: |
packages/core/build/api/
packages/website/build/