[WIP] Create necessary automation workflows by Copilot · Pull Request #6 · objectstack-ai/docs

Copilot · 2026-01-15T11:37:09Z

Create Required Automation Workflows

Creating necessary GitHub Actions automation workflows for the documentation repository.

Plan

Workflows Created

CI Workflow (.github/workflows/ci.yml)
- Runs on pull requests and pushes to main branch
- Installs dependencies with npm ci (using package-lock.json)
- Runs TypeScript type checking with npx tsc --noEmit
- Builds the Next.js application
- Uploads build artifacts for 7 days
- Uses pinned action versions (checkout@v4, setup-node@v4, upload-artifact@v4)
- Security: Explicit contents: read permission
Link Check Workflow (.github/workflows/link-check.yml)
- Checks links in content directory (all .md and .mdx files)
- Checks links in README.md
- Runs on PRs that modify content (checks only modified files)
- Scheduled weekly on Mondays at 00:00 UTC (checks all files)
- Can be triggered manually via workflow_dispatch
- Uses pinned action version (markdown-link-check@v1.0.15)
- Security: Explicit contents: read permission
Preview Deployment Workflow (.github/workflows/preview.yml)
- Automatically comments on PRs with deployment information
- Provides context about Vercel deployments and available languages
- Uses pinned action versions (checkout@v4, github-script@v7)
- Security: Explicit contents: read and pull-requests: write permissions
PR Labeler Workflow (.github/workflows/label.yml)
- Automatically labels PRs based on changed files
- Labels: documentation, i18n, ui, configuration, dependencies, workflows
- Uses pinned action version (labeler@v5.0.0)
- Already has explicit permissions defined
Dependabot Configuration (.github/dependabot.yml)
- Weekly npm dependency updates on Mondays
- Monthly GitHub Actions version updates
- Automatic PR creation with proper labels and commit message prefixes

Supporting Files

.github/labeler.yml - Configuration for PR labeling based on file paths
.github/markdown-link-check-config.json - Link checker configuration with timeouts, retries, and status codes

Security & Best Practices

✅ All workflows have explicit GITHUB_TOKEN permissions (principle of least privilege)
✅ All actions pinned to specific versions for reproducibility and security
✅ CodeQL security checks: PASSED (0 alerts)
✅ All YAML/JSON syntax validated
✅ TypeScript type checking tested and working
✅ Build command tested successfully

Original prompt

创建必须的自动化工作流

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

vercel · 2026-01-15T11:37:14Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
docs	Ready	Preview, Comment	Jan 16, 2026 5:27am

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

…eviewers Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

…fine labeler patterns Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

github-actions · 2026-01-15T11:54:05Z

🚀 Preview Deployment

This pull request will be automatically deployed to Vercel.

Preview Links

📝 Documentation: Will be available once Vercel deployment completes
🌍 Languages: English (/en/docs) and Chinese (/zh-CN/docs)

Build Status

Check the CI workflow for build status and any errors.

Automated preview information for PR #6

huangyiirene · 2026-01-15T12:13:17Z

@copilot 继续

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

…n-for-actions

github-actions · 2026-01-16T05:27:25Z

🚀 Preview Deployment

This pull request will be automatically deployed to Vercel.

Preview Links

📝 Documentation: Will be available once Vercel deployment completes
🌍 Languages: English (/en/docs) and Chinese (/zh-CN/docs)

Build Status

Check the CI workflow for build status and any errors.

Automated preview information for PR #6

Copilot

Pull request overview

This pull request adds comprehensive GitHub Actions automation workflows to the documentation repository. The PR creates CI/CD workflows, automated dependency management, link checking, PR labeling, and deployment preview notifications.

Changes:

Added CI workflow for building, type-checking, and testing the Next.js documentation site
Added automated link checking for markdown files with weekly scheduled runs
Added PR auto-labeling based on file changes
Added Dependabot configuration for npm and GitHub Actions dependency updates
Added preview deployment notification workflow for pull requests

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
`.github/workflows/ci.yml`	CI workflow for building and testing the documentation site on PRs and main branch
`.github/workflows/link-check.yml`	Automated link checking for markdown files with scheduled runs and PR triggers
`.github/workflows/label.yml`	Automatic PR labeling based on file path patterns
`.github/workflows/preview.yml`	Posts preview deployment information as PR comments
`.github/dependabot.yml`	Configures automated dependency updates for npm and GitHub Actions
`.github/labeler.yml`	Configuration file defining label rules based on file patterns
`.github/markdown-link-check-config.json`	Configuration for link checker with timeout and retry settings

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-16T05:32:22Z

+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: comment
+            });


The preview workflow will create a new comment on every PR update (synchronize event). This could lead to comment spam on PRs with multiple commits. Consider checking for existing comments and updating them instead, or use a bot identifier and delete previous comments before creating a new one.

Copilot · 2026-01-16T05:32:22Z

+      - name: Checkout code
+        uses: actions/checkout@v4
+


The checkout step is unnecessary in this workflow since the script doesn't interact with repository files. Removing this step would make the workflow faster and more efficient.

Suggested change

- name: Checkout code

uses: actions/checkout@v4

Copilot · 2026-01-16T05:32:23Z

+      - '*.tsx'
+


The pattern '.tsx' only matches TypeScript files in the root directory. If the intent is to match all TSX files, use '**/.tsx'. However, since 'app/**/*.tsx' is already specified, this pattern seems redundant unless there are TSX files expected in the root.

Suggested change

- '*.tsx'

Copilot · 2026-01-16T05:32:23Z

+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'no'
+          config-file: '.github/markdown-link-check-config.json'
+          folder-path: 'content/'
+          check-modified-files-only: ${{ github.event_name == 'pull_request' && 'yes' || 'no' }}
+
+      - name: Check links in root markdown files
+        uses: gaurav-nelson/github-action-markdown-link-check@v1.0.15
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'no'
+          config-file: '.github/markdown-link-check-config.json'
+          file-path: './README.md'
+          check-modified-files-only: ${{ github.event_name == 'pull_request' && 'yes' || 'no' }}


The link check workflow uses 'yes'/'no' string values. While this works with the action, using boolean values (true/false) without quotes would be more idiomatic for GitHub Actions workflows and clearer in intent.

Suggested change

use-quiet-mode: 'yes'

use-verbose-mode: 'no'

config-file: '.github/markdown-link-check-config.json'

folder-path: 'content/'

check-modified-files-only: ${{ github.event_name == 'pull_request' && 'yes' || 'no' }}

- name: Check links in root markdown files

uses: gaurav-nelson/github-action-markdown-link-check@v1.0.15

with:

use-quiet-mode: 'yes'

use-verbose-mode: 'no'

config-file: '.github/markdown-link-check-config.json'

file-path: './README.md'

check-modified-files-only: ${{ github.event_name == 'pull_request' && 'yes' || 'no' }}

use-quiet-mode: true

use-verbose-mode: false

config-file: '.github/markdown-link-check-config.json'

folder-path: 'content/'

check-modified-files-only: ${{ github.event_name == 'pull_request' }}

- name: Check links in root markdown files

uses: gaurav-nelson/github-action-markdown-link-check@v1.0.15

with:

use-quiet-mode: true

use-verbose-mode: false

config-file: '.github/markdown-link-check-config.json'

file-path: './README.md'

check-modified-files-only: ${{ github.event_name == 'pull_request' }}

Initial plan

6af8d04

Copilot AI assigned Copilot and huangyiirene Jan 15, 2026

Copilot started work on behalf of huangyiirene January 15, 2026 11:37 View session

vercel Bot deployed to Preview January 15, 2026 11:37 View deployment

Add automation workflows for CI, dependencies, and PR management

22aaffb

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel Bot deployed to Preview January 15, 2026 11:42 View deployment

Address code review feedback: improve link checking and remove team r…

7e59104

…eviewers Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel Bot deployed to Preview January 15, 2026 11:44 View deployment

Fix link checking for scheduled runs, remove unused variables, and re…

5d2acac

…fine labeler patterns Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel Bot deployed to Preview January 15, 2026 11:45 View deployment

Fix link checker configuration to properly handle folder and file paths

93eea7a

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel Bot deployed to Preview January 15, 2026 11:46 View deployment

Add explicit GITHUB_TOKEN permissions to workflows for security

c776949

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel Bot deployed to Preview January 15, 2026 11:48 View deployment

Pin action versions to specific releases and fix deployment comment

f134230

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel Bot deployed to Preview January 15, 2026 11:49 View deployment

github-actions Bot added the workflows label Jan 15, 2026

Copilot AI requested a review from huangyiirene January 15, 2026 11:58

Copilot started work on behalf of huangyiirene January 15, 2026 12:13 View session

Copilot AI and others added 3 commits January 15, 2026 12:33

Initial plan

907ec82

Add source file generation step before type checking in CI

0a4d9f3

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Merge pull request #8 from objectstack-ai/copilot/update-documentatio…

9c33ed2

…n-for-actions

vercel Bot deployed to Preview January 16, 2026 05:27 View deployment

hotlong marked this pull request as ready for review January 16, 2026 05:30

Copilot AI review requested due to automatic review settings January 16, 2026 05:30

hotlong merged commit c3368c7 into main Jan 16, 2026
7 checks passed

Copilot started reviewing on behalf of hotlong January 16, 2026 05:30 View session

Copilot AI reviewed Jan 16, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[WIP] Create necessary automation workflows#6

[WIP] Create necessary automation workflows#6
hotlong merged 10 commits into
mainfrom
copilot/create-required-automation-workflows

Copilot AI commented Jan 15, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jan 15, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jan 15, 2026

Uh oh!

huangyiirene commented Jan 15, 2026

Uh oh!

github-actions Bot commented Jan 16, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 16, 2026

Uh oh!

Copilot AI Jan 16, 2026

Uh oh!

Copilot AI Jan 16, 2026

Uh oh!

Copilot AI Jan 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

Copilot AI commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Create Required Automation Workflows

Plan

Workflows Created

Supporting Files

Security & Best Practices

Uh oh!

vercel Bot commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jan 15, 2026

🚀 Preview Deployment

Preview Links

Build Status

Uh oh!

huangyiirene commented Jan 15, 2026

Uh oh!

github-actions Bot commented Jan 16, 2026

🚀 Preview Deployment

Preview Links

Build Status

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Jan 15, 2026 •

edited

Loading

vercel Bot commented Jan 15, 2026 •

edited

Loading