Skip to content

Commit 9ab8f18

Browse files
afc163afc163
authored
chore: standardize repository config (#165)
* chore: standardize repository config * fix: keep default CodeQL setup * chore: address AI review feedback * docs: standardize README release details * ci: make surge preview non-blocking * ci: keep surge preview as fallback * docs: refine README usage and ecosystem note * ci: isolate surge preview token * chore: address review comments * docs: add Chinese README * docs: add Ant Design logo to README * docs: refine bilingual README branding * chore: standardize rc tooling and docs * chore: address standardization review comments * chore: include father config in type checks * docs: add license file * ci: use actions checkout v7 * chore: standardize package metadata * ci: standardize dependabot updates * chore: ignore generated docs artifacts * chore: refine preview workflow ignores * docs: polish Chinese README wording * chore: align tooling ignores and typescript * docs: polish Chinese README wording * docs: document dumi dev server port * chore: standardize husky configuration * chore: standardize package type entry * docs: normalize readme badges * ci: limit reusable workflow secrets * ci: restore reusable workflow compatibility * docs: polish zh-CN readme wording * ci: narrow surge preview permissions * chore: limit reusable workflow secrets
1 parent 149568c commit 9ab8f18

18 files changed

Lines changed: 448 additions & 135 deletions

‎.dumirc.ts‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
1-
// more config: https://d.umijs.org/config
21
import { defineConfig } from 'dumi';
2+
import path from 'path';
3+
4+
const basePath = process.env.GH_PAGES ? '/switch/' : '/';
5+
const publicPath = basePath;
36

47
export default defineConfig({
8+
alias: {
9+
'@rc-component/switch$': path.resolve('src'),
10+
'@rc-component/switch/es': path.resolve('src'),
11+
'@rc-component/switch/assets': path.resolve('assets'),
12+
},
13+
mfsu: false,
514
favicons: ['https://avatars0.githubusercontent.com/u/9441414?s=200&v=4'],
615
themeConfig: {
7-
name: 'rc-switch',
16+
name: 'Switch',
817
logo: 'https://avatars0.githubusercontent.com/u/9441414?s=200&v=4',
918
},
10-
outputPath: '.doc',
11-
exportStatic: {},
12-
base: '/switch',
13-
publicPath: '/switch/',
14-
hash: true,
19+
outputPath: 'docs-dist',
20+
base: basePath,
21+
publicPath,
1522
});

‎.eslintignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
.eslintrc.js
22
es/
33
lib/
4-
.doc/
4+
.doc/
5+
docs-dist/
6+
.vercel/

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: ant-design
2+
open_collective: ant-design

‎.github/dependabot.yml‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
version: 2
22
updates:
3-
- package-ecosystem: npm
4-
directory: "/"
5-
schedule:
6-
interval: daily
7-
time: "21:00"
8-
open-pull-requests-limit: 10
9-
ignore:
10-
- dependency-name: less
11-
versions:
12-
- 4.1.0
3+
- package-ecosystem: npm
4+
directory: '/'
5+
schedule:
6+
interval: weekly
7+
day: monday
8+
time: '21:00'
9+
timezone: Asia/Shanghai
10+
open-pull-requests-limit: 10
11+
12+
- package-ecosystem: github-actions
13+
directory: '/'
14+
schedule:
15+
interval: weekly
16+
day: monday
17+
time: '21:00'
18+
timezone: Asia/Shanghai
19+
open-pull-requests-limit: 10

‎.github/workflows/main.yml‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎.github/workflows/react-component-ci.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: ✅ test
2+
on:
3+
push:
4+
branches: [master]
5+
pull_request:
6+
branches: [master]
7+
permissions:
8+
contents: read
9+
jobs:
10+
test:
11+
uses: react-component/rc-test/.github/workflows/test-utoo.yml@main
12+
secrets:
13+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

‎.github/workflows/react-doctor.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: React Doctor
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize, reopened, ready_for_review]
6+
push:
7+
branches: [master]
8+
9+
permissions:
10+
contents: read
11+
pull-requests: write
12+
issues: write
13+
statuses: write
14+
15+
concurrency:
16+
group: react-doctor-${{ github.event.pull_request.number || github.ref }}
17+
cancel-in-progress: true
18+
19+
jobs:
20+
react-doctor:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v7
24+
with:
25+
fetch-depth: 0
26+
persist-credentials: false
27+
- uses: millionco/react-doctor@0b4f4f4bd248a154e64eb508a48347f71154b3f3

‎.github/workflows/surge-preview.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Surge Preview
2+
3+
on:
4+
pull_request:
5+
6+
concurrency:
7+
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
8+
cancel-in-progress: true
9+
10+
permissions:
11+
contents: read
12+
pull-requests: write
13+
checks: write
14+
15+
jobs:
16+
preview:
17+
runs-on: ubuntu-latest
18+
concurrency:
19+
group: surge-preview-${{ github.event.pull_request.number }}
20+
cancel-in-progress: true
21+
env:
22+
PREVIEW: true
23+
steps:
24+
- uses: actions/checkout@v7
25+
with:
26+
persist-credentials: false
27+
- name: Check Surge token
28+
id: surge-token
29+
env:
30+
SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
31+
run: |
32+
if [ -n "$SURGE_TOKEN" ]; then
33+
echo "enabled=true" >> "$GITHUB_OUTPUT"
34+
else
35+
echo "enabled=false" >> "$GITHUB_OUTPUT"
36+
fi
37+
- name: Build preview
38+
if: ${{ steps.surge-token.outputs.enabled == 'true' }}
39+
run: |
40+
npm install
41+
npm run build
42+
- uses: afc163/surge-preview@bf90a5a86111f6311ca42f0a5a0f80fb0fb03cec
43+
if: ${{ steps.surge-token.outputs.enabled == 'true' }}
44+
env:
45+
SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
46+
with:
47+
surge_token: ${{ env.SURGE_TOKEN }}
48+
github_token: ${{ secrets.GITHUB_TOKEN }}
49+
dist: docs-dist
50+
failOnError: false
51+
setCommitStatus: false
52+
- name: Skip Surge preview
53+
if: ${{ steps.surge-token.outputs.enabled != 'true' }}
54+
run: echo "SURGE_TOKEN is not configured; skip Surge preview."

‎.gitignore‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
*.iml
22
*.log
3+
*.log.*
34
.idea/
45
.ipr
56
.iws
@@ -20,20 +21,29 @@ Thumbs.db
2021
.build
2122
node_modules
2223
.cache
24+
dist
2325
assets/**/*.css
2426
build
2527
lib
2628
es
29+
/coverage
2730
yarn.lock
2831
package-lock.json
2932
pnpm-lock.yaml
30-
coverage/
33+
.doc
34+
docs-dist
35+
.vercel
36+
.storybook
3137

32-
# dumi
33-
.dumi/tmp
34-
.dumi/tmp-test
35-
.dumi/tmp-production
38+
# umi
39+
.umi
40+
.umi-production
41+
.umi-test
3642
.env.local
37-
.doc/
43+
.dumi/
3844

39-
bun.lockb
45+
bun.lockb
46+
bun.lock
47+
coverage
48+
.dumi/tmp
49+
.dumi/tmp-production

‎.husky/pre-commit‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
1-
#!/usr/bin/env sh
2-
. "$(dirname -- "$0")/_/husky.sh"
3-
41
npx lint-staged

0 commit comments

Comments
 (0)