Skip to content

Commit 27315e5

Browse files
committed
feat: bump to vben main branch
2 parents 97217fa + e815f0f commit 27315e5

File tree

972 files changed

+52493
-3849
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

972 files changed

+52493
-3849
lines changed

.changeset/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changesets
2+
3+
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works with multi-package repos, or single-package repos to help you version and publish your code. You can find the full documentation for it [in our repository](https://github.com/changesets/changesets)
4+
5+
We have a quick list of common questions to get you started engaging with this project in [our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
3+
"changelog": [
4+
"@changesets/changelog-github",
5+
{ "repo": "vbenjs/vue-vben-admin" }
6+
],
7+
"commit": false,
8+
"fixed": [["@vben-core/*", "@vben/*"]],
9+
"snapshot": {
10+
"prereleaseTemplate": "{tag}-{datetime}"
11+
},
12+
"privatePackages": { "version": true, "tag": true },
13+
"linked": [],
14+
"access": "public",
15+
"baseBranch": "main",
16+
"updateInternalDependencies": "patch",
17+
"ignore": []
18+
}

.editorconfig

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
root = true
2+
3+
[*]
4+
charset=utf-8
5+
end_of_line=lf
6+
insert_final_newline=true
7+
indent_style=space
8+
indent_size=2
9+
max_line_length = 100
10+
trim_trailing_whitespace = true
11+
quote_type = single
12+
13+
[*.{yml,yaml,json}]
14+
indent_style = space
15+
indent_size = 2
16+
17+
[*.md]
18+
trim_trailing_whitespace = false

.gitconfig

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[core]
2+
ignorecase = false

.github/ISSUE_TEMPLATE/bug-report.yml

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: 🐞 Bug Report
2+
description: Report an issue with Vben Admin to help us make it better.
3+
title: 'Bug: '
4+
labels: ['bug: pending triage']
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
- type: dropdown
12+
id: version
13+
attributes:
14+
label: Version
15+
description: What version of our software are you running?
16+
options:
17+
- Vben Admin V5
18+
- Vben Admin V2
19+
default: 0
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: bug-desc
25+
attributes:
26+
label: Describe the bug?
27+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
28+
placeholder: Bug Description
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: reproduction
34+
attributes:
35+
label: Reproduction
36+
description: Please provide a link to [StackBlitz](https://stackblitz.com/fork/github/vitest-dev/vitest/tree/main/examples/basic?initialPath=__vitest__/) (you can also use [examples](https://github.com/vitest-dev/vitest/tree/main/examples)) or a github repo that can reproduce the problem you ran into. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "needs reproduction" label. If no reproduction is provided after 3 days, it will be auto-closed.
37+
placeholder: Reproduction
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: system-info
43+
attributes:
44+
label: System Info
45+
description: Output of `npx envinfo --system --npmPackages '{vue}' --binaries --browsers`
46+
render: shell
47+
placeholder: System, Binaries, Browsers
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: logs
53+
attributes:
54+
label: Relevant log output
55+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
56+
render: shell
57+
58+
- type: checkboxes
59+
id: terms
60+
attributes:
61+
label: Validations
62+
description: Before submitting the issue, please make sure you do the following
63+
# description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com).
64+
options:
65+
- label: Read the [docs](https://doc.vben.pro/)
66+
required: true
67+
- label: Ensure the code is up to date. (Some issues have been fixed in the latest version)
68+
required: true
69+
- label: I have searched the [existing issues](https://github.com/vbenjs/vue-vben-admin/issues) and checked that my issue does not duplicate any existing issues.
70+
required: true
71+
- label: Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/vbenjs/vue-vben-admin/discussions) or join our [Discord Chat Server](https://discord.gg/8GuAdwDhj6).
72+
required: true
73+
- label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
74+
required: true

.github/ISSUE_TEMPLATE/docs.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: 📚 Documentation
2+
description: Report an issue with Vben Admin Website to help us make it better.
3+
title: 'Docs: '
4+
labels: [documentation]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this issue!
10+
- type: checkboxes
11+
id: documentation_is
12+
attributes:
13+
label: Documentation is
14+
options:
15+
- label: Missing
16+
- label: Outdated
17+
- label: Confusing
18+
- label: Not sure?
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Explain in Detail
23+
description: A clear and concise description of your suggestion. If you intend to submit a PR for this issue, tell us in the description. Thanks!
24+
placeholder: The description of ... page is not clear. I thought it meant ... but it wasn't.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: suggestion
29+
attributes:
30+
label: Your Suggestion for Changes
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: reproduction-steps
35+
attributes:
36+
label: Steps to reproduce
37+
description: Please provide any reproduction steps that may need to be described. E.g. if it happens only when running the dev or build script make sure it's clear which one to use.
38+
placeholder: Run `pnpm install` followed by `pnpm run docs:dev`
+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: ✨ New Feature Proposal
2+
description: Propose a new feature to be added to Vben Admin
3+
title: 'FEATURE: '
4+
labels: ['enhancement: pending triage']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting a feature for our project! Please fill out the information below to help us understand and implement your request!
10+
- type: dropdown
11+
id: version
12+
attributes:
13+
label: Version
14+
description: What version of our software are you running?
15+
options:
16+
- Vben Admin V5
17+
- Vben Admin V2
18+
default: 0
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Description
26+
description: A detailed description of the feature request.
27+
placeholder: Please describe the feature you would like to see, and why it would be useful.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: proposed-solution
33+
attributes:
34+
label: Proposed Solution
35+
description: A clear and concise description of what you want to happen.
36+
placeholder: Describe the solution you'd like to see
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: alternatives
42+
attributes:
43+
label: Alternatives Considered
44+
description: |
45+
A clear and concise description of any alternative solutions or features you've considered.
46+
placeholder: Describe any alternative solutions or features you've considered
47+
validations:
48+
required: false
49+
50+
- type: input
51+
id: additional-context
52+
attributes:
53+
label: Additional Context
54+
description: Add any other context or screenshots about the feature request here.
55+
placeholder: Any additional information
56+
validations:
57+
required: false
58+
59+
- type: checkboxes
60+
id: checkboxes
61+
attributes:
62+
label: Validations
63+
description: Before submitting the issue, please make sure you do the following
64+
options:
65+
- label: Read the [docs](https://doc.vben.pro/)
66+
required: true
67+
- label: Ensure the code is up to date. (Some issues have been fixed in the latest version)
68+
required: true
69+
- label: I have searched the [existing issues](https://github.com/vbenjs/vue-vben-admin/issues) and checked that my issue does not duplicate any existing issues.
70+
required: true

.github/actions/setup-node/action.yml

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: 'Setup Node'
2+
3+
description: 'Setup node and pnpm'
4+
5+
runs:
6+
using: 'composite'
7+
steps:
8+
- name: Install pnpm
9+
uses: pnpm/action-setup@v4
10+
11+
- name: Install Node.js
12+
uses: actions/setup-node@v4
13+
with:
14+
node-version-file: .node-version
15+
cache: 'pnpm'
16+
17+
- name: Get pnpm store directory
18+
shell: bash
19+
run: |
20+
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
21+
22+
- uses: actions/cache@v4
23+
name: Setup pnpm cache
24+
if: ${{ github.ref_name == 'main' }}
25+
with:
26+
path: ${{ env.STORE_PATH }}
27+
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
28+
restore-keys: |
29+
${{ runner.os }}-pnpm-store-
30+
31+
- uses: actions/cache/restore@v4
32+
if: ${{ github.ref_name != 'main' }}
33+
with:
34+
path: ${{ env.STORE_PATH }}
35+
key: |
36+
${{ runner.os }}-pnpm-store-
37+
38+
- name: Install dependencies
39+
shell: bash
40+
run: pnpm install --frozen-lockfile

.github/commit-convention.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
## Git Commit Message Convention
2+
3+
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
4+
5+
#### TL;DR:
6+
7+
Messages must be matched by the following regex:
8+
9+
```js
10+
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip): .{1,50}/;
11+
```
12+
13+
#### Examples
14+
15+
Appears under "Features" header, `dev` subheader:
16+
17+
```
18+
feat(dev): add 'comments' option
19+
```
20+
21+
Appears under "Bug Fixes" header, `dev` subheader, with a link to issue #28:
22+
23+
```
24+
fix(dev): fix dev error
25+
26+
close #28
27+
```
28+
29+
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
30+
31+
```
32+
perf(build): remove 'foo' option
33+
34+
BREAKING CHANGE: The 'foo' option has been removed.
35+
```
36+
37+
The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
38+
39+
```
40+
revert: feat(compiler): add 'comments' option
41+
42+
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
43+
```
44+
45+
### Full Message Format
46+
47+
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
48+
49+
```
50+
<type>(<scope>): <subject>
51+
<BLANK LINE>
52+
<body>
53+
<BLANK LINE>
54+
<footer>
55+
```
56+
57+
The **header** is mandatory and the **scope** of the header is optional.
58+
59+
### Revert
60+
61+
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
62+
63+
### Type
64+
65+
If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
66+
67+
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
68+
69+
### Scope
70+
71+
The scope could be anything specifying the place of the commit change. For example `dev`, `build`, `workflow`, `cli` etc...
72+
73+
### Subject
74+
75+
The subject contains a succinct description of the change:
76+
77+
- use the imperative, present tense: "change" not "changed" nor "changes"
78+
- don't capitalize the first letter
79+
- no dot (.) at the end
80+
81+
### Body
82+
83+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
84+
85+
### Footer
86+
87+
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
88+
89+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

0 commit comments

Comments
 (0)