Skip to content

Commit f63f46a

Browse files
authored
chore: standardize repository config (#381)
* 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 * 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 * docs: localize Chinese README descriptions * chore: refine preview workflow ignores * 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 * ci: narrow surge preview permissions * chore: limit reusable workflow secrets
1 parent cd0ca3c commit f63f46a

17 files changed

Lines changed: 488 additions & 248 deletions

.dumirc.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
11
import { defineConfig } from 'dumi';
22
import path from 'path';
33

4+
const basePath = process.env.GH_PAGES ? '/steps/' : '/';
5+
const publicPath = basePath;
6+
47
export default defineConfig({
58
alias: {
69
'@rc-component/steps$': path.resolve('src'),
710
'@rc-component/steps/es': path.resolve('src'),
11+
'@rc-component/steps/assets': path.resolve('assets'),
812
},
913
mfsu: false,
1014
favicons: ['https://avatars0.githubusercontent.com/u/9441414?s=200&v=4'],
1115
themeConfig: {
1216
name: 'Steps',
1317
logo: 'https://avatars0.githubusercontent.com/u/9441414?s=200&v=4',
1418
},
15-
});
19+
outputPath: 'docs-dist',
20+
base: basePath,
21+
publicPath,
22+
});

.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 & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +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: "@types/react-dom"
11-
versions:
12-
- 17.0.0
13-
- 17.0.1
14-
- 17.0.2
15-
- dependency-name: "@types/react"
16-
versions:
17-
- 17.0.0
18-
- 17.0.1
19-
- 17.0.2
20-
- 17.0.3
21-
- dependency-name: less
22-
versions:
23-
- 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.
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
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: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
.iml
1+
*.iml
22
*.log
3+
*.log.*
34
.idea/
45
.ipr
56
.iws
@@ -25,18 +26,24 @@ assets/**/*.css
2526
build
2627
lib
2728
es
28-
coverage
29+
/coverage
30+
yarn.lock
2931
package-lock.json
3032
pnpm-lock.yaml
31-
yarn.lock
3233
.doc
34+
docs-dist
35+
.vercel
36+
.storybook
37+
38+
# umi
3339
.umi
34-
.npmrc
40+
.umi-production
41+
.umi-test
42+
.env.local
43+
.dumi/
3544

36-
# dumi
45+
bun.lockb
46+
bun.lock
47+
coverage
3748
.dumi/tmp
38-
.dumi/tmp-test
3949
.dumi/tmp-production
40-
.env.local
41-
42-
bun.lockb

.husky/pre-commit

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
npx lint-staged

.prettierignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
node_modules
2+
coverage
3+
docs-dist
4+
dist
5+
es
6+
lib
7+
.dumi/tmp
8+
.dumi/tmp-production
9+
.vercel
10+
package-lock.json
11+
pnpm-lock.yaml
12+
yarn.lock
13+
bun.lockb
14+
*.log

0 commit comments

Comments
 (0)