Merge pull request #266 from khaneliman/github-action

Add github actions

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/labeler.yml

@@ -0,0 +1,23 @@
+repo:
+- '*'
+
+GitHub-Action:
+- .github/workflows/*
+
+Configs:
+- configs/**/*
+
+Package-Files:
+- pkg-files/**/*
+
+scripts:
+- scripts/**/*
+
+debug:
+- scripts/debug/**/*
+
+helpers:
+- scripts/helpers/**/*
+
+installers:
+- scripts/installers/**/*

.github/workflows/combine.yml

@@ -0,0 +1,18 @@
+name: "Combine Dependabot PRs"
+on:
+  workflow_dispatch:
+
+jobs:
+  combine-prs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.3
+      - uses: maadhattah/combine-dependabot-prs@main
+        with:
+          branchPrefix: "dependabot"
+          mustBeGreen: true
+          combineBranchName: "combined-prs"
+          ignoreLabel: "nocombine"
+          baseBranch: "main"
+          openPR: true
+          allowSkipped: false

.github/workflows/generate-documentation.yml

@@ -0,0 +1,27 @@
+name: Generate Documentation
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Github Action genshdoc
+      id: action-genshdoc
+      uses: vargiuscuola/genshdoc@master
+    - name: genshdoc result
+      run: echo "The result of genshdoc Action was ${{ steps.action-genshdoc.outputs.result }}"
+    - name: Commit files
+      run: |
+        echo ${{ github.ref }}
+        git add .
+        git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "github-actions[bot]"
+        git commit -m "CI: Automated build push" -a | exit 0
+    - name: Push changes
+      if: github.ref == 'refs/heads/main'
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/label.yml

@@ -0,0 +1,22 @@
+# This workflow will triage pull requests and apply a label based on the
+# paths that are modified in the pull request.
+#
+# To use this workflow, you will need to set up a .github/labeler.yml
+# file with configuration.  For more information, see:
+# https://github.com/actions/labeler
+
+name: Labeler
+on: [pull_request]
+
+jobs:
+  label:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+    - uses: actions/labeler@v4
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/linter.yml

@@ -0,0 +1,55 @@
+---
+#################################
+#################################
+## Super Linter GitHub Actions ##
+#################################
+#################################
+name: Lint Code Base
+
+#
+# Documentation:
+# https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
+#
+
+#############################
+# Start the job on all push #
+#############################
+on:
+  push:
+    branches-ignore: [master, main]
+    # Remove the line above to run when pushing to master
+  pull_request:
+    branches: [master, main]
+
+###############
+# Set the Job #
+###############
+jobs:
+  build:
+    # Name the Job
+    name: Lint Code Base
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      ################################
+      # Run Linter against code base #
+      ################################
+      - name: Lint Code Base
+        uses: github/super-linter@v4
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CODEOWNERS

@@ -0,0 +1,6 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+# Order is important. The last matching pattern has the most precedence.
+
+# These owners will be the default owners for everything in the repo.
+* @ChrisTitusTech

README.md

@@ -1,4 +1,5 @@
 # ArchTitus Installer Script
+[![GitHub Super-Linter](https://github.com/ChrisTitusTech/ArchTitus/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
 
 <img src="https://i.imgur.com/YiNMnan.png" />
 
@@ -23,12 +24,15 @@ cd ArchTitus
 ```
 
 ### System Description
-This is completely automated arch install of the KDE desktop environment on arch using all the packages I use on a daily basis. 
+This is completely automated arch install. It includes prompts to select your desired desktop environment, window manager, AUR helper, and whether to do a full or minimal install. The KDE desktop environment on arch includes all the packages I use on a daily basis, as well as some customizations.
 
 ## Troubleshooting
 
-__[Arch Linux Installation Guide](https://github.com/rickellis/Arch-Linux-Install-Guide)__
+__[Arch Linux RickEllis Installation Guide](https://github.com/rickellis/Arch-Linux-Install-Guide)__
 
+__[Arch Linux Wiki Installation Guide](https://wiki.archlinux.org/title/Installation_guide)__
+
+The main script will generate .log files for every script that is run as part of the installation process. These log files contain the terminal output so you can review any warnings or errors that occurred during installation and aid in troubleshooting. 
 ### No Wifi
 
 You can check if the WiFi is blocked by running `rfkill list`.
@@ -46,6 +50,14 @@ After unblocking the WiFi, you can connect to it. Go through these 5 steps:
 
 #5: Find your network, and run `station [device name] connect [network name]`, enter your password and run `exit`. You can test if you have internet connection by running `ping google.com`, and then Press Ctrl and C to stop the ping test.
 
+## Reporting Issues
+
+An issue is easier to resolve if it contains a few important pieces of information.
+1. Chosen configuration from /configs/setup.conf (DONT INCLUDE PASSWORDS)
+1. Errors seen in .log files
+1. What commit/branch you used
+1. Where you were installing (VMWare, Virtualbox, Virt-Manager, Baremetal, etc)
+    1. If a VM, what was the configuration used.
 ## Credits
 
 - Original packages script was a post install cleanup script called ArchMatic located here: https://github.com/rickellis/ArchMatic

archtitus.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+#github-action genshdoc
 
 # Find the name of the folder the scripts are in
 set -a

scripts/0-preinstall.sh

@@ -7,6 +7,7 @@
 #  ██║  ██║██║  ██║╚██████╗██║  ██║   ██║   ██║   ██║   ╚██████╔╝███████║
 #  ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝╚═╝  ╚═╝   ╚═╝   ╚═╝   ╚═╝    ╚═════╝ ╚══════╝
 #-------------------------------------------------------------------------
+#github-action genshdoc
 
 echo -ne "
 -------------------------------------------------------------------------

scripts/1-setup.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+#github-action genshdoc
 echo -ne "
 -------------------------------------------------------------------------
    █████╗ ██████╗  ██████╗██╗  ██╗████████╗██╗████████╗██╗   ██╗███████╗

scripts/2-user.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+#github-action genshdoc
 echo -ne "
 -------------------------------------------------------------------------
    █████╗ ██████╗  ██████╗██╗  ██╗████████╗██╗████████╗██╗   ██╗███████╗

scripts/3-post-setup.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+#github-action genshdoc
 echo -ne "
 -------------------------------------------------------------------------
    █████╗ ██████╗  ██████╗██╗  ██╗████████╗██╗████████╗██╗   ██╗███████╗

scripts/startup.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+#github-action genshdoc
 # This script will ask users about their prefrences 
 # like disk, file system, timezone, keyboard layout,
 # user name, password, etc.