Merge pull request #27 from SUSTech-data/abao/ci

ci: add document workflow

Author: AbaoFromCUG

.github/workflows/build.yml

@@ -1,7 +1,7 @@
 name: Build
 on:
   push:
-    branches: main
+    branches: master
   pull_request:
     branches: '*'
 concurrency:

.github/workflows/check-release.yml

@@ -1,14 +1,12 @@
 name: Check Release
 on:
   push:
-    branches: [main]
+    branches: [master]
   pull_request:
     branches: ['*']
-
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
-
 jobs:
   check_release:
     runs-on: ubuntu-latest
@@ -28,7 +26,6 @@ jobs:
         uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-
       - name: Upload Distributions
         uses: actions/upload-artifact@v4
         with:

.github/workflows/publish.yaml renamed to .github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: Update docs
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+jobs:
+  update-docs:
+    name: Update README and doc
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Make document
+        run: |
+          make document
+      - name: Push changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "auto-generate document"
+          commit_user_name: "github-actions[bot]"
+          commit_user_email: "github-actions[bot]@users.noreply.github.com"
+          commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"

.github/workflows/update-docs.yml

@@ -1,6 +1,5 @@
 #!/usr/bin/env sh
 
 make test
-make document
 pnpm lint-staged
 pnpm run test

.husky/pre-commit

@@ -1,10 +1,11 @@
 # Contributing
 
-## Install Dependencies
+## Dependencies
+
+* Node.js
+* pnpm
+* python
 
-```shell
-pip install hatch hatch-nodejs-version pytest pytest_jupyter ruff
-```
 
 ## JupyterLab Extension
 
@@ -16,6 +17,7 @@ Note: You will need `NodeJS` to build the extension package. Recommend use `pnpm
 # Clone the repo to your local environment
 # Change directory to the current project directory
 # Install package in development mode
+# This step will some additional tools, e.g. ruff
 pip install -e ".[dev]"
 # Link your development version of the extension with JupyterLab
 jupyter labextension develop . --overwrite

CONTRIBUTING.md

@@ -24,7 +24,7 @@ hatch version <new-version>
 Make sure to clean up all the development files before building the package:
 
 ```bash
-jlpm clean:all
+pnpm clean:all
 ```
 
 You could also clean up the local git repository:

RELEASE.md

@@ -6,6 +6,8 @@ export default antfu({
     quotes: 'single',
   },
   toml: false,
+  yaml: false,
+  markdown: false,
   typescript: true,
 }, {
   rules: {

eslint.config.js

@@ -30,6 +30,7 @@ dynamic = ["version", "description", "authors", "urls", "keywords"]
 dev = [
     # build
     "hatch",
+    "hatch-nodejs-version",
     # formatter
     "ruff",
     # test

pnpm-lock.yaml

@@ -2,12 +2,12 @@ import process from 'node:process';
 /**
  * Configuration for Playwright using default from @jupyterlab/galata
  */
-import baseConfig from '@jupyterlab/galata/lib/playwright-config';
+import baseConfig from '@jupyterlab/galata/lib/playwright-config.js';
 
 export default {
   ...baseConfig,
   webServer: {
-    command: 'jlpm start',
+    command: 'pnpm start',
     url: 'http://localhost:8888/lab',
     timeout: 120 * 1000,
     reuseExistingServer: !process.env.CI,