Skip to content

Commit 2f73869

Browse files
Merge branch 'main' into flatpak
2 parents fb7f025 + ad678b2 commit 2f73869

Some content is hidden

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

79 files changed

+1448
-663
lines changed

.cargo/config.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[alias]
2+
xtask = "run --package xtask --"

.github/CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ cd linutil
1616
```
1717

1818
## 3. Make your changes
19+
1920
- **Edit the files you want to change**: Make your changes to the relevant files.
2021
- **Test your changes**: Run `cargo run` to test your modifications in a local environment and ensure everything works as expected.
2122

@@ -60,6 +61,7 @@ cd linutil
6061
## 11. Documentation
6162

6263
- **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this.
64+
- **Automatic generation**: If you decide to add functionality through a new shell script, make sure to fill out all fields in `tab_data.toml` and run `cargo xtask docgen`.
6365

6466
## 12. License
6567

.github/SECURITY.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,20 @@
22

33
## Supported Versions
44

5-
It is recommended that you run the stable version as this is more tested and used by most. The dev branch is bleed-edge commits that are not well tested and aren't meant to be used in production environments
5+
It is recommended that you use the stable branch as it's tested and used by most. The dev branch may contain bleeding-edge commits that are not well tested and are not meant to be used in production environments.<br>
6+
Version tags lower than the [latest stable release](https://github.com/ChrisTitusTech/linutil/releases/latest) are **not** supported.
67

7-
| Version | Supported |
8-
| ------- | ------------------ |
9-
| latest | :white_check_mark: |
10-
| dev | :x: |
8+
| Branch | Supported |
9+
| ------- | ---------------------- |
10+
| Stable | :white_check_mark: YES |
11+
| Dev | :x: NO |
12+
13+
| Version | Supported |
14+
| -------------------------------------------------- | ---------------------- |
15+
| [![LATEST](https://img.shields.io/github/v/release/ChrisTitusTech/linutil?color=%230567ff&label=Latest&style=for-the-badge)](https://github.com/ChrisTitusTech/linutil/releases/latest) | :white_check_mark: YES |
16+
| Below LATEST | :x: NO |
17+
| Above LATEST | :x: NO |
1118

1219
## Reporting a Vulnerability
1320

14-
I'd recommend making an Issue for reporting a bug. If you would like privately submit the bug you can email me at contact@christitus.com
21+
If you have any reason to believe there are security vulnerabilities in Linutil, fill out the [report form](https://github.com/christitustech/linutil/security/advisories/new) or e-mail [contact@christitus.com](mailto:contact@christitus.com).

.github/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav:
66
- Introduction: 'index.md'
77
- User Guide: 'userguide.md'
88
- Contributing:
9-
- Contributing Guide: 'contribute.md'
9+
- Contributing Guide: 'contributing.md'
1010
- Roadmap: 'roadmap.md'
1111
- Documentation:
1212
- Known Issues: 'KnownIssues.md'
@@ -86,4 +86,4 @@ plugins:
8686
minify_html: true
8787
htmlmin_opts:
8888
remove_comments: true
89-
cache_safe: true
89+
cache_safe: true

.github/release.yml

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,34 @@ changelog:
22
categories:
33
- title: '🚀 Features'
44
labels:
5-
- 'feature'
65
- 'enhancement'
76
- title: '🐛 Bug Fixes'
87
labels:
9-
- 'fix'
10-
- 'bugfix'
118
- 'bug'
9+
- title: '⚙️ Refactoring'
10+
labels:
11+
- 'refactor'
12+
- title: '🧩 UI/UX'
13+
labels:
14+
- 'UI/UX'
1215
- title: '📚 Documentation'
13-
label: 'documentation'
16+
labels:
17+
- 'documentation'
1418
- title: '🔒 Security'
15-
label: 'security'
19+
labels:
20+
- 'security'
1621
- title: '🧰 GitHub Actions'
17-
label: 'github actions'
22+
labels:
23+
- 'github_actions'
24+
- title: '🦀 Rust'
25+
labels:
26+
- 'rust'
27+
- title: '📃 Scripting'
28+
labels:
29+
- 'script'
30+
- title: 'Other Changes'
31+
labels:
32+
- "*"
1833
exclude:
1934
labels:
20-
- 'skip-changelog'
35+
- 'skip-changelog'

.github/workflows/bashisms.yml

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,27 @@ jobs:
1919
id: get_sh_files
2020
run: |
2121
sh_files=$(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs | grep '\.sh$' || true)
22-
echo "::set-output name=sh_files::$sh_files"
22+
if [ -n "$sh_files" ]; then
23+
echo "$sh_files" > changed_files
24+
echo "changed=1" >> $GITHUB_OUTPUT
25+
else
26+
echo "changed=0" >> $GITHUB_OUTPUT
27+
fi
2328
2429
- name: Install devscripts
25-
if: steps.get_sh_files.outputs.sh_files != ''
30+
if: steps.get_sh_files.outputs.changed == 1
2631
run: sudo apt-get update && sudo apt-get install devscripts
2732

2833
- name: Check for bashisms
29-
if: steps.get_sh_files.outputs.sh_files != ''
34+
if: steps.get_sh_files.outputs.changed == 1
3035
run: |
31-
for file in ${{ steps.get_sh_files.outputs.sh_files }}; do
32-
if [[ -f "$file" ]]; then
33-
checkbashisms "$file"
34-
fi
36+
echo "Running for:\n$(cat changed_files)\n"
37+
for file in $(cat changed_files); do
38+
if [[ -f "$file" ]]; then
39+
checkbashisms "$file"
40+
fi
3541
done
42+
43+
- name: Remove the created file
44+
if: steps.get_sh_files.outputs.changed == 1
45+
run: rm changed_files

.github/workflows/github-pages.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ jobs:
2020
with:
2121
fetch-depth: '0' # Fetch all commit history for all branches as well as tags.
2222

23+
- name: Copy Contributing Guidelines
24+
run: |
25+
echo -e "<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->\n\n$(cat .github/CONTRIBUTING.md)" > 'docs/contributing.md'
26+
27+
- uses: stefanzweifel/git-auto-commit-action@v5
28+
with:
29+
commit_message: Commit Contributing Guidelines
30+
file_pattern: "docs/contributing.md"
31+
add_options: '--force'
32+
if: success()
33+
2334
- name: Setup Python
2435
uses: actions/setup-python@v5
2536
with:

.github/workflows/linutil.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,3 +88,24 @@ jobs:
8888
env:
8989
version: ${{ env.version }}
9090
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
91+
92+
- name: Setup Preview
93+
run: |
94+
echo "$(pwd)/build" >> $GITHUB_PATH
95+
96+
- name: Generate preview
97+
uses: charmbracelet/vhs-action@v2.1.0
98+
with:
99+
path: "docs/assets/preview.tape"
100+
101+
- name: Move preview
102+
run: |
103+
mv preview.gif docs/assets/preview.gif
104+
105+
- name: Upload preview
106+
uses: stefanzweifel/git-auto-commit-action@v5
107+
with:
108+
commit_message: Preview for ${{ env.version }}
109+
file_pattern: "docs/assets/preview.gif"
110+
add_options: "--force"
111+
if: success()

.github/workflows/rust.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
branches: ["main"]
66
paths:
77
- '**/*.rs'
8-
- 'Cargo.toml'
8+
- '**/Cargo.toml'
99
- 'Cargo.lock'
1010

1111
env:

.github/workflows/shellcheck.yml

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,34 @@
1-
name: ShellCheck
1+
name: Script Checks
22

33
on:
44
pull_request:
55
paths:
6-
- 'core/tabs/**/*.sh'
6+
- '**/*.sh'
77
workflow_dispatch:
88

99
jobs:
1010
shellcheck:
1111
name: Shellcheck
1212
runs-on: ubuntu-latest
1313
steps:
14-
- uses: actions/checkout@v4
15-
- run: git fetch origin ${{ github.base_ref }}
14+
- name: Checkout sources
15+
uses: actions/checkout@v4
1616

17-
- name: Download and set up shellcheck
18-
run : |
19-
wget https://github.com/koalaman/shellcheck/releases/download/v0.10.0/shellcheck-v0.10.0.linux.x86_64.tar.xz
20-
tar -xf shellcheck-v0.10.0.linux.x86_64.tar.xz
21-
cd shellcheck-v0.10.0
22-
chmod +x shellcheck
17+
- name: Run ShellCheck
18+
uses: reviewdog/action-shellcheck@v1
19+
with:
20+
reviewdog_flags: '-fail-level=any'
2321

24-
- name: Run shellcheck
25-
run: |
26-
for file in $(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs); do
27-
if [[ "$file" == *.sh ]] && [[ -f "$file" ]]; then
28-
./shellcheck-v0.10.0/shellcheck -S error "$file"
29-
fi
30-
done
22+
shfmt:
23+
name: Shell Fomatting
24+
runs-on: ubuntu-latest
25+
needs: shellcheck
26+
steps:
27+
- name: Checkout sources
28+
uses: actions/checkout@v4
29+
30+
- name: Run shfmt
31+
uses: reviewdog/action-shfmt@v1
32+
with:
33+
shfmt_flags: '-i 4 -ci'
34+
reviewdog_flags: '-fail-level=any'

0 commit comments

Comments
 (0)