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

69 lines
1.9 KiB
YAML
Raw Permalink Normal View History

chore: fix build error and introduce a build github workflow (#71) Fix imports that are not respecting the case of the filenames. The build often has errors and they are only detected after a developer pull the `development` branch on their local machine. To early catch build failures, add a GitHub workflow that runs a build command.
2022-01-14 05:17:38 +00:00
name: Build
on:
push:
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/**/*'
chore: fix build error and introduce a build github workflow (#71) Fix imports that are not respecting the case of the filenames. The build often has errors and they are only detected after a developer pull the `development` branch on their local machine. To early catch build failures, add a GitHub workflow that runs a build command.
2022-01-14 05:17:38 +00:00
- '.github/workflows/build.yml'
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
- '.eslint*'
chore: build with Node 18 (#263)
2023-11-16 13:39:08 +00:00
- '.nvmrc'
chore: fix build error and introduce a build github workflow (#71) Fix imports that are not respecting the case of the filenames. The build often has errors and they are only detected after a developer pull the `development` branch on their local machine. To early catch build failures, add a GitHub workflow that runs a build command.
2022-01-14 05:17:38 +00:00
- 'packages/**/*'
docs: improve the release process (#177) Clarify some git operations. Also - move an image to the packages/docs for future reuse in the documentation. - don't run the GitHub "build" workflow when the docs package or some markdown files change.
2023-05-22 14:13:33 +00:00
- '!packages/**/*.md'
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
- '!packages/website/**/*'
chore: fix build error and introduce a build github workflow (#71) Fix imports that are not respecting the case of the filenames. The build often has errors and they are only detected after a developer pull the `development` branch on their local machine. To early catch build failures, add a GitHub workflow that runs a build command.
2022-01-14 05:17:38 +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'
chore: fix build error and introduce a build github workflow (#71) Fix imports that are not respecting the case of the filenames. The build often has errors and they are only detected after a developer pull the `development` branch on their local machine. To early catch build failures, add a GitHub workflow that runs a build command.
2022-01-14 05:17:38 +00:00
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/**/*'
chore: fix build error and introduce a build github workflow (#71) Fix imports that are not respecting the case of the filenames. The build often has errors and they are only detected after a developer pull the `development` branch on their local machine. To early catch build failures, add a GitHub workflow that runs a build command.
2022-01-14 05:17:38 +00:00
- '.github/workflows/build.yml'
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
- '.eslint*'
- '.nvmrc'
chore: fix build error and introduce a build github workflow (#71) Fix imports that are not respecting the case of the filenames. The build often has errors and they are only detected after a developer pull the `development` branch on their local machine. To early catch build failures, add a GitHub workflow that runs a build command.
2022-01-14 05:17:38 +00:00
- 'packages/**/*'
docs: improve the release process (#177) Clarify some git operations. Also - move an image to the packages/docs for future reuse in the documentation. - don't run the GitHub "build" workflow when the docs package or some markdown files change.
2023-05-22 14:13:33 +00:00
- '!packages/**/*.md'
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
- '!packages/website/**/*'
chore: fix build error and introduce a build github workflow (#71) Fix imports that are not respecting the case of the filenames. The build often has errors and they are only detected after a developer pull the `development` branch on their local machine. To early catch build failures, add a GitHub workflow that runs a build command.
2022-01-14 05:17:38 +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'
chore: fix build error and introduce a build github workflow (#71) Fix imports that are not respecting the case of the filenames. The build often has errors and they are only detected after a developer pull the `development` branch on their local machine. To early catch build failures, add a GitHub workflow that runs a build command.
2022-01-14 05:17:38 +00:00
jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
# we want to run the full build on all os: don't cancel running jobs even if one fails
fail-fast: false
matrix:
ci: use macos-13 in GitHub workflows (#269) Build with a more recent version to better suit developers' machines, which usually use a recent operating system.
2023-12-01 08:51:11 +00:00
os: ['ubuntu-22.04', 'macos-13', 'windows-2022']
chore: fix build error and introduce a build github workflow (#71) Fix imports that are not respecting the case of the filenames. The build often has errors and they are only detected after a developer pull the `development` branch on their local machine. To early catch build failures, add a GitHub workflow that runs a build command.
2022-01-14 05:17:38 +00:00
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
chore: improve the configuration to build the npm package (#87) Root and all package.json files - Fix license, version and authors - Remove the non-relevant .npmignore file at the project. It was designed for mxgraph, the whole directory structure changed, and we don't plan to publish the root package `core` package - Generate type definition and javascript files for ESM output - dedicated folder for `esm` and `types` in the `dist` folder to clearly separate concerns - exported in the package.json - Add npm script for `npm pack` configuration - Drop the `postinstall` npm script that built the `core` bundle. It would have been run when the package is installed in dependent projects at dependencies install. And it would have failed as it tries to build the project from TypeScript sources that are not available in the npm package. fix: ConstraintHandler now loads image as everywhere else in the code using `Client.imageBasePath` Using import doesn't work as the image is not available in the npm package. It generated error like this in ViteJS project: Failed to resolve import "../../../images/point.gif" from "../core/dist/esm/view/handler/ConstraintHandler.js". Does the file exist? This gif import had been introduced to make `Anchors.stories.js` retrieve the gif file. Configuring `imageBasePath` as already done in other stories fixes the issue. Don't export EditorCodec and StylesheetCodec as they generate errors. This is a temporary solution to avoid error in dependent project (at least, with ViteJS projects).
2022-07-05 06:08:25 +00:00
- name: Build @maxgraph/core - esm
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/core
fix: CellOverlay constructor use all parameters to set properties (#159) The `align` and `verticalAlign` values passed to the constructor weren't set, so the overlay position was always set to the default one. The `align` and `verticalAlign` properties are now using the AlignValue and VAlignValue types respectively instead of defining inline types. This improves the consistent in the whole code. To demonstrate the fix, the Overlays story now set 'align' and 'verticalAlign' randomly. Also introduce `jest` to test the fix and the whole implementation of the changed method. Types check support is provided by `ts-jest`. As maxGraph uses a lot of browser objects, also setup `jest-jsdom-environment`.
2022-12-16 15:51:51 +00:00
- name: Test @maxgraph/core
ci: upload test coverage results (#298) Also rename the artifact storing all examples for clarity.
2023-12-29 06:24:34 +00:00
run: npm test -w packages/core -- --coverage
- name: Upload test results as artifact
uses: actions/upload-artifact@v4
with:
name: test-coverage-${{runner.os}}-${{github.sha}}
path: packages/core/coverage/lcov-report
docs: set the minimum TypeScript requirement to 3.8 (#128) We use a recent TypeScript version to build maxGraph but applications that integrates it may be forced to use old TypeScript versions. We never explain what is the minimum TypeScript version requires to use `maxGraph`. The changes proposed here are a first step to make this information available. It is only informative for now (mentioned in the README) and the minimum TypeScript version is tested in the `ts-support` package (part of the 'build' GitHub workflow).
2022-11-07 17:31:40 +00:00
- name: Test TypeScript support
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 test -w packages/ts-support
chore: improve the configuration to build the npm package (#87) Root and all package.json files - Fix license, version and authors - Remove the non-relevant .npmignore file at the project. It was designed for mxgraph, the whole directory structure changed, and we don't plan to publish the root package `core` package - Generate type definition and javascript files for ESM output - dedicated folder for `esm` and `types` in the `dist` folder to clearly separate concerns - exported in the package.json - Add npm script for `npm pack` configuration - Drop the `postinstall` npm script that built the `core` bundle. It would have been run when the package is installed in dependent projects at dependencies install. And it would have failed as it tries to build the project from TypeScript sources that are not available in the npm package. fix: ConstraintHandler now loads image as everywhere else in the code using `Client.imageBasePath` Using import doesn't work as the image is not available in the npm package. It generated error like this in ViteJS project: Failed to resolve import "../../../images/point.gif" from "../core/dist/esm/view/handler/ConstraintHandler.js". Does the file exist? This gif import had been introduced to make `Anchors.stories.js` retrieve the gif file. Configuring `imageBasePath` as already done in other stories fixes the issue. Don't export EditorCodec and StylesheetCodec as they generate errors. This is a temporary solution to avoid error in dependent project (at least, with ViteJS projects).
2022-07-05 06:08:25 +00:00
- name: Build ts-example
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/ts-example
chore: migrate to storybook v7 (#230) - Migrate the existing stories to work with storybook v7. - Use the `vite` builder. The startup time decrease from 40 seconds (best time with v6) to 1 second (worst time with v7) - Webpack is no more used, `vite` now manages everything - Add support for writing stories in TypeScript. It also detect existing import errors in the existing stories written in JS - Migrate the Toolbar story to TypeScript to demonstrate it works. As part of the migration, fix how CellStyle is set in the story (easily detected thanks to types checking) - Detect wrong imports in stories and fix them - The storybook mini-site can be built (previously the build always failed and storybook could only be used in development mode) - Add support for Node 18 Other changes - core: simplify the "dev" script: - There is no need to invoke webpack as the UMD bundle is no longer used by stories. - Instead, call `tsc` watch which is faster, so code changes are visible faster in stories - "Build" GitHub workflow: - Build storybook mini-site and attach all examples as artifact to help reviewing Pull Requests - Lint at the end, this is more important to check the build and examples first
2023-10-12 21:41:37 +00:00
- name: Build Storybook mini-site
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/html
chore: migrate to storybook v7 (#230) - Migrate the existing stories to work with storybook v7. - Use the `vite` builder. The startup time decrease from 40 seconds (best time with v6) to 1 second (worst time with v7) - Webpack is no more used, `vite` now manages everything - Add support for writing stories in TypeScript. It also detect existing import errors in the existing stories written in JS - Migrate the Toolbar story to TypeScript to demonstrate it works. As part of the migration, fix how CellStyle is set in the story (easily detected thanks to types checking) - Detect wrong imports in stories and fix them - The storybook mini-site can be built (previously the build always failed and storybook could only be used in development mode) - Add support for Node 18 Other changes - core: simplify the "dev" script: - There is no need to invoke webpack as the UMD bundle is no longer used by stories. - Instead, call `tsc` watch which is faster, so code changes are visible faster in stories - "Build" GitHub workflow: - Build storybook mini-site and attach all examples as artifact to help reviewing Pull Requests - Lint at the end, this is more important to check the build and examples first
2023-10-12 21:41:37 +00:00
- name: Upload all examples as 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
chore: migrate to storybook v7 (#230) - Migrate the existing stories to work with storybook v7. - Use the `vite` builder. The startup time decrease from 40 seconds (best time with v6) to 1 second (worst time with v7) - Webpack is no more used, `vite` now manages everything - Add support for writing stories in TypeScript. It also detect existing import errors in the existing stories written in JS - Migrate the Toolbar story to TypeScript to demonstrate it works. As part of the migration, fix how CellStyle is set in the story (easily detected thanks to types checking) - Detect wrong imports in stories and fix them - The storybook mini-site can be built (previously the build always failed and storybook could only be used in development mode) - Add support for Node 18 Other changes - core: simplify the "dev" script: - There is no need to invoke webpack as the UMD bundle is no longer used by stories. - Instead, call `tsc` watch which is faster, so code changes are visible faster in stories - "Build" GitHub workflow: - Build storybook mini-site and attach all examples as artifact to help reviewing Pull Requests - Lint at the end, this is more important to check the build and examples first
2023-10-12 21:41:37 +00:00
with:
ci: upload test coverage results (#298) Also rename the artifact storing all examples for clarity.
2023-12-29 06:24:34 +00:00
name: examples-${{runner.os}}-${{github.sha}}
chore: migrate to storybook v7 (#230) - Migrate the existing stories to work with storybook v7. - Use the `vite` builder. The startup time decrease from 40 seconds (best time with v6) to 1 second (worst time with v7) - Webpack is no more used, `vite` now manages everything - Add support for writing stories in TypeScript. It also detect existing import errors in the existing stories written in JS - Migrate the Toolbar story to TypeScript to demonstrate it works. As part of the migration, fix how CellStyle is set in the story (easily detected thanks to types checking) - Detect wrong imports in stories and fix them - The storybook mini-site can be built (previously the build always failed and storybook could only be used in development mode) - Add support for Node 18 Other changes - core: simplify the "dev" script: - There is no need to invoke webpack as the UMD bundle is no longer used by stories. - Instead, call `tsc` watch which is faster, so code changes are visible faster in stories - "Build" GitHub workflow: - Build storybook mini-site and attach all examples as artifact to help reviewing Pull Requests - Lint at the end, this is more important to check the build and examples first
2023-10-12 21:41:37 +00:00
path: |
packages/html/dist/
packages/ts-example/dist/
- name: Ensure no lint errors
run: npm run lint