Skip to content

Commit 3bcdb38

Browse files
chore: update CI workflows and add autofix capabilities (#1446)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent c240056 commit 3bcdb38

File tree

212 files changed

+9146
-5500
lines changed

Some content is hidden

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

212 files changed

+9146
-5500
lines changed

.github/ISSUE_TEMPLATE/BUGS.yml

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
name: "Bug Report 🪲"
22
description: Report an issue or possible bug with the functionality of the Solid docs website. (Not related to the content of the site.)
33
title: "[Bug]: "
4-
labels: [
5-
"bug",
6-
"pending review"
7-
]
8-
assignees:
9-
- danieljcafonso
10-
- atilafassina
4+
labels: ["bug", "pending review"]
5+
assignees:
6+
- danieljcafonso
7+
- atilafassina
118

129
body:
1310
- type: textarea
@@ -25,21 +22,21 @@ body:
2522
description: Please indicate on which page(s) the issue occurs.
2623
placeholder: https://docs.solidjs.com/concepts/intro-to-reactivity
2724
validations:
28-
required: true
25+
required: true
2926
- type: textarea
3027
id: expected
3128
attributes:
3229
label: "🤔 Expected Behavior"
3330
description: Please describe what the expected behavior should be.
34-
placeholder: When on this page, I expected . . .
31+
placeholder: When on this page, I expected . . .
3532
validations:
3633
required: true
3734
- type: textarea
3835
id: current
3936
attributes:
4037
label: "👀 Current Behavior"
4138
description: Please describe what the current behavior is.
42-
placeholder: But instead, on this page I'm noticing . . .
39+
placeholder: But instead, on this page I'm noticing . . .
4340
validations:
4441
required: true
4542
- type: input

.github/ISSUE_TEMPLATE/CONTENT.yml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
name: "Content Report 📄"
22
title: "[Content]:"
33
description: Report an issue with existing content.
4-
labels: [
5-
"improve documentation", "pending review"
6-
]
7-
assignees:
8-
- ladybluenotes
4+
labels: ["improve documentation", "pending review"]
5+
assignees:
6+
- ladybluenotes
97
body:
108
- type: markdown
119
attributes:
@@ -25,19 +23,19 @@ body:
2523
description: Please provide the URL of the page(s) affected.
2624
placeholder: https://docs.solidjs.com/concepts/intro-to-reactivity
2725
validations:
28-
required: true
26+
required: true
2927
- type: textarea
3028
id: generalDesc
3129
attributes:
3230
label: "📋 Description of content that is out-of-date or incorrect"
3331
description: Let us know what's wrong!
3432
placeholder: "..."
3533
validations:
36-
required: true
34+
required: true
3735
- type: textarea
3836
id: incorrectContent
3937
attributes:
4038
label: "🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)"
4139
description: If you are reporting incorrect content or code samples, you can also attach a reproduction in stackblitz.
4240
validations:
43-
required: false
41+
required: false

.github/ISSUE_TEMPLATE/REQUEST.yml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
name: "Request 💡"
22
title: "[Request]:"
33
description: Share an idea.
4-
labels: [
5-
"request", "pending review"
6-
]
4+
labels: ["request", "pending review"]
75
assignees:
8-
- ladybluenotes
6+
- ladybluenotes
97
body:
108
- type: markdown
119
attributes:
@@ -14,7 +12,7 @@ body:
1412
id: request-topic
1513
attributes:
1614
label: "What is this request related to?"
17-
options:
15+
options:
1816
- Request
1917
- Styling
2018
- Feature
@@ -27,20 +25,20 @@ body:
2725
description: Please provide the URL of the page(s) or section this idea is related to.
2826
placeholder: https://docs.solidjs.com/concepts/intro-to-reactivity
2927
validations:
30-
required: false
28+
required: false
3129
- type: textarea
3230
id: generalDesc
3331
attributes:
3432
label: "📋 General description or bullet points"
3533
description: Please provide a general description or bullet points about what you would like to see added.
3634
placeholder: "..."
3735
validations:
38-
required: true
36+
required: true
3937
- type: textarea
4038
id: example
4139
attributes:
4240
label: "🖥️ Reproduction of code samples in StackBlitz"
4341
description: If you would like to suggest code samples please attach a working reproduction.
4442
placeholder: "..."
4543
validations:
46-
required: false
44+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ blank_issues_enabled: true
22
contact_links:
33
- name: Support & Community 💁
44
url: https://discord.com/invite/solidjs
5-
about: 'This issue tracker is not for support questions. Our Discord server hosts the community of Solid users. Come join us to discuss Solid or find assistance!'
5+
about: "This issue tracker is not for support questions. Our Discord server hosts the community of Solid users. Come join us to discuss Solid or find assistance!"

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- [ ] This PR references an issue (except for typos, broken links, or other minor problems)
55

66
### Description(required)
7+
78
<!-- Provide a detailed description of the changes in this PR. Why is it necessary, and what does it do? -->
89

910
### Related issues & labels

.github/workflows/autofix.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: autofix.ci
2+
3+
on:
4+
pull_request:
5+
6+
concurrency:
7+
group: ${{ github.workflow }}-${{ github.event.number || github.ref }}
8+
cancel-in-progress: true
9+
10+
permissions:
11+
contents: write
12+
13+
jobs:
14+
autofix:
15+
name: autofix
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v5.0.0
20+
with:
21+
fetch-depth: 0
22+
- name: Setup Tools
23+
uses: ./.github/actions/install
24+
- name: Fix lint issues
25+
run: pnpm lint:fix
26+
- name: Fix formatting
27+
run: pnpm format
28+
- name: Apply fixes
29+
uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27
30+
with:
31+
commit-message: "ci: apply automated fixes"

.github/workflows/static_checks.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
runs-on: ubuntu-latest
1919
steps:
2020
- name: Check out code
21-
uses: actions/checkout@v4
21+
uses: actions/checkout@v5
2222

2323
- name: Install tools & dependencies
2424
uses: ./.github/actions/install
@@ -33,10 +33,13 @@ jobs:
3333
runs-on: ubuntu-latest
3434
steps:
3535
- name: Check out code
36-
uses: actions/checkout@v4
36+
uses: actions/checkout@v5
3737

3838
- name: Install tools & dependencies
3939
uses: ./.github/actions/install
4040

4141
- name: Lint code
4242
run: pnpm check:lint
43+
44+
- name: Check formatting
45+
run: pnpm exec prettier . --check

.prettierignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.solid
22
dist
33
*.min.*
4-
package-lock.json
4+
package-lock.json
5+
.github/ISSUE_TEMPLATE/OTHER.yml

.prettierrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
"semi": true,
55
"singleQuote": false,
66
"useTabs": true,
7-
"plugins": ["prettier-plugin-tailwindcss"]
7+
"plugins": ["prettier-plugin-tailwindcss"]
88
}

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,13 +133,13 @@ Though it is not a hard requirement, we'd deeply appreciate if you could recomme
133133

134134
1. Create a dictionary file in `src/i18n/dictionaries/{locale}/ui.ts`. The name should follow our locale convention.
135135

136-
- language (ISO 639-1 - set 1): https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
137-
- country code(optional) (ISO 3166-1 alpha-2): https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
138-
- E.g.: Canadian French would be: `fr-ca`
136+
- language (ISO 639-1 - set 1): https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
137+
- country code(optional) (ISO 3166-1 alpha-2): https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
138+
- E.g.: Canadian French would be: `fr-ca`
139139

140140
2. Add the `import` and language information to the objects in the barrel file: `./src/i18n/dictionaries/index.ts`. So it will be identified by the routing system, and an entry its added to the language dropdown.
141141
3. Add the language to the `array` in `./scripts/collections/index.mjs` so internal files are created.
142-
4. Add the important UI translations to `./src/i18n/dictionaries/{locale}/ui.ts`
142+
4. Add the important UI translations to `./src/i18n/dictionaries/{locale}/ui.ts`
143143
5. Add at least the index page `./src/routes/{locale}/index.mdx`, so others and yourself could see things in action.
144144

145145
#### Adding translations to a supported language

0 commit comments

Comments
 (0)