Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
67 changes: 36 additions & 31 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -1,54 +1,59 @@
# Add 'core' label to any change within the 'core' package
core:
- packages/vrender/**
- changed-files:
- any-glob-to-any-file: 'packages/vrender/**'

# Add 'react' label to any change within the 'core' package
react:
- packages/react-vrender/**
- changed-files:
- any-glob-to-any-file: 'packages/react-vrender/**'

# Add 'hierarchy' label to any change within the 'core' package
react-utils:
- packages/react-vrender-utils/**
- changed-files:
- any-glob-to-any-file: 'packages/react-vrender-utils/**'

# Add 'projection' label to any change within the 'core' package
components:
- packages/vrender-components/**
- changed-files:
- any-glob-to-any-file: 'packages/vrender-components/**'

# Add 'sankey' label to any change within the 'core' package
kits:
- packages/vrender-kits/**
- changed-files:
- any-glob-to-any-file: 'packages/vrender-kits/**'

# Add 'test' label to any change to packages/*/__tests__/* files within the source dir
test:
- packages/*/__tests__/*
- changed-files:
- any-glob-to-any-file: 'packages/*/__tests__/*'

# Add 'docs' label to any change to docs/ files within the source dir
docs:
- docs/**
- changed-files:
- any-glob-to-any-file: 'docs/**'

# Add 'eslint' label to any change to docs/ files within the source dir
eslint:
- share/eslint-config/**
- packages/*/.eslintrc.js
- changed-files:
- any-glob-to-any-file:
- 'share/eslint-config/**'
- 'packages/*/.eslintrc.js'

# Add 'jest' label to any change to docs/ files within the source dir
jest:
- share/jest-config/**
- packages/*/jest.config.js
- changed-files:
- any-glob-to-any-file:
- 'share/jest-config/**'
- 'packages/*/jest.config.js'

# Add 'typescript' label to any change to docs/ files within the source dir
typescript:
- share/ts-config/**
- packages/*/tsconfig.json
- packages/*/tsconfig.eslint.json
- changed-files:
- any-glob-to-any-file:
- 'share/ts-config/**'
- 'packages/*/tsconfig.json'
- 'packages/*/tsconfig.eslint.json'

# Add 'bundler' label to any change to tools/bunder/** files within the source dir
bundler:
- tools/bundler/**
- packages/*/bundler.config.js
- changed-files:
- any-glob-to-any-file:
- 'tools/bundler/**'
- 'packages/*/bundler.config.js'

# Add 'chore' label to any change to common/** files within the source dir
chore:
- common/autoinstallers/**
- common/git-hooks/**
- common/scripts/**
- changed-files:
- any-glob-to-any-file:
- 'common/autoinstallers/**'
- 'common/git-hooks/**'
- 'common/scripts/**'
11 changes: 3 additions & 8 deletions .github/workflows/bug-server.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,12 @@ jobs:
build:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [18.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
- uses: actions/checkout@v3
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- name: Use Node.js 24.x
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
node-version: 24.x
cache: 'npm'
cache-dependency-path: './common/config/rush/pnpm-lock.yaml'

Expand Down
11 changes: 3 additions & 8 deletions .github/workflows/pr-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,12 @@ jobs:
build:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [20.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
- uses: actions/checkout@v3
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- name: Use Node.js 24.x
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
node-version: 24.x
cache: 'npm'
cache-dependency-path: './common/config/rush/pnpm-lock.yaml'

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release-changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:

strategy:
matrix:
node-version: [18.x]
node-version: [24.x]

steps:
- name: Checkout
Expand All @@ -22,7 +22,7 @@ jobs:
git config user.email ${{ github.actor }}@users.noreply.github.com

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:

strategy:
matrix:
node-version: [20.x]
node-version: [24.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/sync-main-to-develop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:

strategy:
matrix:
node-version: [18.x]
node-version: [24.x]

steps:
- uses: actions/checkout@v3
Expand All @@ -28,7 +28,7 @@ jobs:
git config user.email ${{ github.actor }}@users.noreply.github.com

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
Expand Down
11 changes: 3 additions & 8 deletions .github/workflows/unit-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,12 @@ jobs:
runs-on:
- macos-latest

strategy:
matrix:
node-version: [18.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
- uses: actions/checkout@v3
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- name: Use Node.js 24.x
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
node-version: 24.x
cache: 'npm'
cache-dependency-path: './common/config/rush/pnpm-lock.yaml'

Expand Down
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,14 @@ The core team is monitoring for pull requests. We will review your pull request

## Development Workflow

After cloning VRender, run `rush update --full` to fetch its dependencies. Then, you can run several commands:
VRender development is verified against Node.js `20`, `22`, and `24`. We recommend using Node.js `24` for day-to-day local development.

If you switch between Node.js major versions, make sure to rebuild native dependencies such as `canvas`:

1. `node common/scripts/install-run-rush.js purge`
2. `node common/scripts/install-run-rush.js install --bypass-policy`

After cloning VRender, run `node common/scripts/install-run-rush.js update --bypass-policy` to fetch its dependencies. Then, you can run several commands:

1. `rush run -p @internal/dev-demos -s start` runs VRender test page locally.
2. `rush eslint` checks the code style.
Expand Down
Loading
Loading