feat/ci: add markdownlint and codespell workflow

Vanilla-OS · Sep 4, 2023 · 381f4e8 · 381f4e8
1 parent 26f18ff
commit 381f4e8
Show file tree

Hide file tree

Showing 13 changed files with 70 additions and 11 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,40 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+    types: [opened, synchronize, ready_for_review, edited]
+
+jobs:
+    markdownlint:
+        runs-on: ubuntu-latest
+
+        steps:
+          - uses: actions/checkout@v3
+
+          - name: Run markdownlint
+            run: |
+              sudo npm install -g markdownlint-cli
+              markdownlint $(find . -name '*.md' | grep -vF './.git')
+    
+    codespell:
+        runs-on: ubuntu-latest
+
+        steps:
+        - uses: actions/checkout@v3
+
+        - name: Get changed files
+          id: changed-files
+          uses: tj-actions/changed-files@v38
+          with:
+            # Ignore all other languages except English
+            files: |
+              articles/en/*.md
+
+        - uses: codespell-project/actions-codespell@v2
+          with:
+            # Only check files in the PR
+            path: |
+                ${{ steps.changed-files.outputs.all_changed_files }}
diff --git a/.markdownlint.yml b/.markdownlint.yml
@@ -0,0 +1,12 @@
+---
+MD010: false
+MD013:
+  line_length: 600
+  code_blocks: false
+  tables: false
+  headings: false
+  headers: false
+MD024: false
+MD033: false
+MD036: false
+MD041: false
diff --git a/LICENSE → LICENSE.txt b/LICENSE → LICENSE.txt
@@ -658,4 +658,4 @@ specific requirements.
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU AGPL, see
-<https://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
diff --git a/_posts/2016-11-25-test.md b/_posts/2016-11-25-test.md
@@ -17,15 +17,15 @@ Iaculis eu non diam phasellus vestibulum lorem sed risus ultricies. Sit amet dic
 
 Mollis nunc sed id semper risus in hendrerit. Ullamcorper sit amet risus nullam. In mollis nunc sed id semper risus in hendrerit gravida. Urna condimentum mattis pellentesque id nibh tortor id. Aliquam faucibus purus in massa tempor nec feugiat. Id neque aliquam vestibulum morbi blandit cursus risus. Ut venenatis tellus in metus. Mattis aliquam faucibus purus in massa tempor.
 
-### Lorem ipsum
+### Lorem ipsum1
 
 Id venenatis a condimentum vitae sapien pellentesque. Sed vulputate odio ut enim blandit volutpat maecenas volutpat. Bibendum at varius vel pharetra. Purus in mollis nunc sed. Urna cursus eget nunc scelerisque viverra. Semper quis lectus nulla at. Adipiscing enim eu turpis egestas. Nibh praesent tristique magna sit amet purus gravida quis blandit. Etiam non quam lacus suspendisse faucibus. Amet mauris commodo quis imperdiet massa.
 
-#### Lorem ipsum
+#### Lorem ipsum2
 
 Vitae semper quis lectus nulla at volutpat diam. Neque gravida in fermentum et sollicitudin. Eget magna fermentum iaculis eu non. Elit pellentesque habitant morbi tristique senectus et netus. Viverra maecenas accumsan lacus vel facilisis volutpat est velit. Posuere ac ut consequat semper viverra. Tempus quam pellentesque nec nam. Sed egestas egestas fringilla phasellus faucibus scelerisque eleifend donec pretium. Diam in arcu cursus euismod quis viverra nibh cras. Amet purus gravida quis blandit turpis cursus in hac habitasse.
 
-## Lorem ipsum
+## Lorem ipsum3
 
 Ut tristique et egestas quis ipsum suspendisse. Congue mauris rhoncus aenean vel elit. Egestas pretium aenean pharetra magna ac placerat vestibulum lectus. Pulvinar etiam non quam lacus suspendisse. Nisi porta lorem mollis aliquam. Erat imperdiet sed euismod nisi porta. Blandit volutpat maecenas volutpat blandit. Tincidunt dui ut ornare lectus sit.
 
@@ -42,7 +42,7 @@ Ut enim blandit volutpat maecenas volutpat blandit aliquam. Diam in arcu cursus
 Lectus quam id leo in vitae turpis massa sed. Enim blandit volutpat maecenas volutpat blandit aliquam etiam. Feugiat sed lectus vestibulum mattis ullamcorper velit sed ullamcorper morbi. Cras tincidunt lobortis feugiat vivamus at augue.
 
 ```bash
-$ echo "Hello World!"
+echo "Hello World!"
 ```
 
 Suspendisse sed nisi lacus sed viverra tellus in hac habitasse. Commodo ullamcorper a lacus vestibulum. Velit scelerisque in dictum non consectetur. Varius vel pharetra vel turpis nunc. Pellentesque id nibh tortor id aliquet lectus proin. Massa sapien faucibus et molestie ac. Nibh mauris cursus mattis molestie a iaculis at erat pellentesque. Hendrerit gravida rutrum quisque non tellus orci. Cras semper auctor neque vitae tempus quam pellentesque. Quis enim lobortis scelerisque fermentum dui faucibus in ornare quam. Malesuada bibendum arcu vitae elementum curabitur vitae nunc. Scelerisque eleifend donec pretium vulputate sapien nec sagittis. Nec nam aliquam sem et tortor consequat. Dictum varius duis at consectetur lorem donec massa. Felis eget velit aliquet sagittis id. Lectus sit amet est placerat. Tempor commodo ullamcorper a lacus vestibulum sed.
diff --git a/_posts/2022-11-05-installation.md b/_posts/2022-11-05-installation.md
@@ -67,6 +67,7 @@ Click "Install Vanilla OS" and set your preferred language, keyboard layout and
 Depending on whether you want to dual- or multiboot Vanilla OS alongside other operating systems, you will need to follow different steps when selecting your disk.
 
 This guide will help you with the following types of installation:
+
 - [Installing only Vanilla OS](/2022/11/05/installation.html#title10)
 - [~~Advanced installation~~ (Disabled currently)](/2022/11/05/installation.html#title11)
 

diff --git a/_posts/2023-01-19-change-default-shell.md b/_posts/2023-01-19-change-default-shell.md
@@ -152,6 +152,7 @@ apx init --aur
 apx init --dnf
 apx init --apk
 ```
+
 **_Warning_**: This will remove all applications installed inside the container!
 
 If you wish to use a specific Shell for your container, you can manually set the SHELL variable before creating the container with the following commands:-

diff --git a/_posts/2023-01-21-install-in-vm.md b/_posts/2023-01-21-install-in-vm.md
@@ -118,7 +118,7 @@ In the first setup, click "Install" on the Open VM Tools page to install the nec
 
 ### Prerequisites
 
-- A Virtual Machine Manager Installation from [**here**](https://virt-manager.org/). 
+- A Virtual Machine Manager Installation from [**here**](https://virt-manager.org/).
 
 - The necessary QEMU dependencies installed.
 
@@ -131,6 +131,7 @@ Launch Virtual Machine Manager from the App Grid. Alternatively, you can run it
 ```bash
 virt-manager
 ```
+
 Click on the "Create a new virtual machine" button in the left corner below the top bar.
 
 ![Virt manager 1](/assets/uploads/VM_Post/Virt-Manager/virt_manager_1.webp)
@@ -327,7 +328,6 @@ Type `reboot` and press enter. You have successfully configured your VM!
 
 You can change more virtual machine performance/sharing/integration options using the Parallels settings menu in the Control Center. Please refer to the [Parallels Knowledge Base](https://kb.parallels.com) for details.
 
-
 ![Parallels 35](/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-35.webp)
 
 ## Install Vanilla OS in VirtualBox
@@ -345,6 +345,7 @@ Launch VirtualBox from the App Grid. Alternatively, you can run it with the foll
 ```bash
 virtualbox
 ```
+
 Click on "New". (This will open the "Create Virtual Machine" Popup)
 
 ![VirtualBox 5](/assets/uploads/VM_Post/Virtualbox/VirtualBox_5.webp)

diff --git a/_posts/2023-01-24-install-openrgb.md b/_posts/2023-01-24-install-openrgb.md
@@ -30,7 +30,7 @@ flatpak install flathub org.openrgb.OpenRGB
 
 ### Prerequisites
 
-AppImage Support: If you have enabled AppImage in the "First Setup" when installing Vanilla OS, this step isn't necessary. 
+AppImage Support: If you have enabled AppImage in the "First Setup" when installing Vanilla OS, this step isn't necessary.
 
 If you haven't enabled AppImages, run the following command:-
 

diff --git a/articles/en/change-default-shell.md b/articles/en/change-default-shell.md
@@ -150,6 +150,7 @@ apx init --aur
 apx init --dnf
 apx init --apk
 ```
+
 **_Warning_**: This will remove all applications installed inside the container!
 
 If you wish to use a specific Shell for your container, you can manually set the SHELL variable before creating the container with the following commands:-

diff --git a/articles/en/install-additional-drivers.md b/articles/en/install-additional-drivers.md
@@ -7,6 +7,7 @@ Authors:
     - kbdharun
     - mrunix00
 ---
+
 Drivers are software components that allow the operating system to communicate with hardware devices.
 
 In Vanilla OS, primary drivers are installed automatically during the first setup, but some devices may need additional drivers to work ideally. You can install them using two methods:-

diff --git a/articles/en/install-in-vm.md b/articles/en/install-in-vm.md
@@ -116,7 +116,7 @@ In the first setup, click "Install" on the Open VM Tools page to install the nec
 
 ### Prerequisites
 
-- A Virtual Machine Manager Installation from [**here**](https://virt-manager.org/). 
+- A Virtual Machine Manager Installation from [**here**](https://virt-manager.org/).
 
 - The necessary QEMU dependencies installed.
 
@@ -129,6 +129,7 @@ Launch Virtual Machine Manager from the App Grid. Alternatively, you can run it
 ```bash
 virt-manager
 ```
+
 Click on the "Create a new virtual machine" button in the left corner below the top bar.
 
 ![Virt manager 1](/assets/uploads/VM_Post/Virt-Manager/virt_manager_1.webp)
@@ -325,7 +326,6 @@ Type `reboot` and press enter. You have successfully configured your VM!
 
 You can change more virtual machine performance/sharing/integration options using the Parallels settings menu in the Control Center. Please refer to the [Parallels Knowledge Base](https://kb.parallels.com) for details.
 
-
 ![Parallels 35](/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-35.webp)
 
 ## Install Vanilla OS in VirtualBox
@@ -343,6 +343,7 @@ Launch VirtualBox from the App Grid. Alternatively, you can run it with the foll
 ```bash
 virtualbox
 ```
+
 Click on "New". (This will open the "Create Virtual Machine" Popup)
 
 ![VirtualBox 5](/assets/uploads/VM_Post/Virtualbox/VirtualBox_5.webp)

diff --git a/articles/en/install-openrgb.md b/articles/en/install-openrgb.md
@@ -28,7 +28,7 @@ flatpak install flathub org.openrgb.OpenRGB
 
 ### Prerequisites
 
-AppImage Support: If you have enabled AppImage in the "First Setup" when installing Vanilla OS, this step isn't necessary. 
+AppImage Support: If you have enabled AppImage in the "First Setup" when installing Vanilla OS, this step isn't necessary.
 
 If you haven't enabled AppImages, run the following command:-
 

diff --git a/articles/en/installation.md b/articles/en/installation.md
@@ -65,6 +65,7 @@ Click "Install Vanilla OS" and set your preferred language, keyboard layout and
 Depending on whether you want to dual- or multiboot Vanilla OS alongside other operating systems, you will need to follow different steps when selecting your disk.
 
 This guide will help you with the following types of installation:
+
 - [Installing only Vanilla OS](/2022/11/05/installation.html#title10)
 - [~~Advanced installation~~ (Disabled currently)](/2022/11/05/installation.html#title11)