Skip to content

Commit c8b2a17

Browse files
ci: 💚 refactor GHA lint tools (#1953)
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
1 parent b3b492e commit c8b2a17

18 files changed

Lines changed: 154 additions & 141 deletions

.editorconfig

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,40 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
14
root = true
25

36
[*]
7+
indent_style = space
8+
indent_size = 2
9+
end_of_line = lf
410
charset = utf-8
511
trim_trailing_whitespace = true
612
insert_final_newline = true
13+
14+
[*.js]
15+
indent_style = space
16+
indent_size = 2
717
end_of_line = lf
818

9-
[**.md]
19+
[*.{json,jsonc}]
1020
indent_style = space
1121
indent_size = 2
22+
end_of_line = lf
1223

13-
[**.sh]
24+
[*.md]
25+
indent_style = space
26+
indent_size = 2
27+
end_of_line = lf
28+
29+
[*.sh]
1430
indent_style = space
1531
indent_size = 4
16-
switch_case_indent = true # like -ci
17-
space_redirects = true # like -sr
32+
end_of_line = lf
33+
switch_case_indent = true # like -ci
34+
space_redirects = true # like -sr
35+
simplify = true # like -s
1836

19-
[**.yaml,**.yml]
37+
[*.{yaml,yml}]
2038
indent_style = space
2139
indent_size = 2
40+
end_of_line = lf

.github/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Try not to [code like a cowboy](https://en.wikipedia.org/wiki/Cowboy_coding).
1414
1. Run `bash /path/to/your/ds-repo/main.sh`
1515
1. The `ds` symlink should be created but let's verify. We'll run `whereis` to see where `ds` is and then run `ls -l` on this path to ensure the symlink points to `/path/to/your/ds-repo/main.sh`. E.g:
1616

17-
```
17+
```shell
1818
dev0@dev0:~/gitsource/DockSTARTer$ whereis ds
1919
ds: /usr/bin/ds /usr/local/bin/ds
2020
dev0@dev0:~/gitsource/DockSTARTer$ ls -l /usr/bin/ds
@@ -29,8 +29,8 @@ So you want to add a new app to DockSTARTer? It's pretty easy if you have a work
2929

3030
1. (Suggested) Develop a functional docker container for your new app in docker-compose.override.yml. Running `ds -c` should succesfully launch your new docker container and you'll be able to test this container to determine what properties should be specified in your docker compose file.
3131
1. Add a new folder in `/path/to/your/ds-repo/compose/.apps` for your new app.
32-
1. Populate the newly created folder above with .yml files. Read through the [YAML files](#YAML-files) section to understand which files to create and how to decompose the container you defined in step 1 above into the various .yml files needed.
33-
1. Test your app .yml files as suggested in the [Testing](#Testing) section. _Note: if you created the docker container (as suggested by step 1) in docker-compose.override.yml you should comment out or delete those lines before testing_
32+
1. Populate the newly created folder above with .yml files. Read through the [YAML files](#yaml-files) section to understand which files to create and how to decompose the container you defined in step 1 above into the various .yml files needed.
33+
1. Test your app .yml files as suggested in the [Testing](#testing) section. _Note: if you created the docker container (as suggested by step 1) in docker-compose.override.yml you should comment out or delete those lines before testing_
3434
1. Write app specific documentation in `/path/to/your/ds-repo/docs/apps/<appname>.md`
3535
1. Create a navigation link in mkdocs for this new documentation written in the step above. Edit the file `/path/to/your/ds-repo/mkdocs.yml`
3636

.github/ISSUE_TEMPLATE/application-request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ labels: "apps, docs, enhancement"
66
assignees: ""
77
---
88

9-
# Name of the application
9+
## Name of the application
1010

1111
## GitHub
1212

1313
## Docker Hub/GitHub Registry
1414

15-
### Additional context
15+
## Additional context
1616

1717
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ labels: "bug"
66
assignees: ""
77
---
88

9-
# Bug report
10-
119
**Describe the bug**
1210
A clear and concise description of what the bug is.
1311

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ labels: "enhancement"
66
assignees: ""
77
---
88

9-
# Feature request
10-
119
**Is your feature request related to a problem? Please describe.**
1210
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1311

.github/dependabot.yml

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

.github/renovate.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": [
4+
"config:best-practices",
5+
"customManagers:githubActionsVersions",
6+
":automergeBranch",
7+
":automergeLinters",
8+
":automergeStableNonMajor",
9+
":automergeTesters",
10+
":automergeTypes",
11+
":enableVulnerabilityAlerts",
12+
":renovatePrefix",
13+
":automergeAll"
14+
],
15+
"baseBranches": ["$default"]
16+
}
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Build and Deploy mkdocs
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
mkdocs:
9+
name: Build and Deploy mkdocs
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout repository
13+
uses: actions/checkout@v4.2.2
14+
with:
15+
fetch-depth: 0
16+
sparse-checkout: |
17+
docs
18+
- name: Setup python
19+
uses: actions/setup-python@v5.6.0
20+
with:
21+
python-version: 3.x
22+
- name: Get pip cache directory
23+
id: pip-cache
24+
run: |
25+
echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
26+
- name: Cache dependencies
27+
uses: actions/cache@v4.2.3
28+
with:
29+
path: ${{ steps.pip-cache.outputs.dir }}
30+
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
31+
restore-keys: |
32+
${{ runner.os }}-pip-
33+
- name: Install dependencies
34+
run: pip install -r docs/requirements.txt
35+
- name: Build documentation
36+
run: mkdocs build
37+
- name: Deploy to GitHub Pages
38+
if: github.event_name == 'push' && contains(fromJson('["refs/heads/master", "refs/heads/main"]'), github.ref)
39+
run: mkdocs gh-deploy --force

.github/workflows/deploy.yml

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

.github/workflows/label.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@
66
# https://github.com/actions/labeler
77

88
name: Labeler
9-
on: [pull_request_target]
9+
10+
on:
11+
pull_request_target:
1012

1113
jobs:
1214
label:
1315
runs-on: ubuntu-latest
14-
1516
steps:
1617
- uses: actions/labeler@v5.0.0
1718
with:

0 commit comments

Comments
 (0)