Skip to content

Commit

Permalink
Add the GitHub Super Linter (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbampton authored Apr 30, 2021
1 parent f491f3c commit e749848
Show file tree
Hide file tree
Showing 11 changed files with 103 additions and 66 deletions.
File renamed without changes.
File renamed without changes.
39 changes: 20 additions & 19 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,29 @@ name: Lint
on: [pull_request]

jobs:
markdownlint:
name: 🧹 Markdown Lint
runs-on: ubuntu-18.04
merge-conflict:
name: Merge Conflict
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Use Node.js
uses: actions/setup-node@v1
with:
node-version: '12.x'
- run: npm install -g [email protected]
- run: markdownlint '**/*.md' --ignore node_modules
shellcheck:
name: 🧹 Shellcheck
- name: Check merge conflict
run: grep "^<<<<<<< HEAD" $(git ls-files | xargs) && exit 1 || true
misspell:
name: Check Spelling
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
yamllint:
name: 🧹 YAML Lint
- name: Check out
uses: actions/checkout@v2
- name: Install
run: |
wget -O - -q https://git.io/misspell | sh -s -- -b .
- name: Misspell
run: |
git ls-files --empty-directory | xargs ./misspell -error
trailing-whitespace:
name: Trailing whitespace
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: yaml-lint
uses: ibiqlik/action-yamllint@v1
- uses: actions/checkout@v2
- name: Check for trailing whitespace
run: "! git grep -EIn $'[ \t]+$'"
19 changes: 19 additions & 0 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Lint Code Base

on: [pull_request]

jobs:
build:
name: GitHub Super Linter
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: github/super-linter@v3
env:
ERROR_ON_MISSING_EXEC_BIT: true
VALIDATE_BASH: true
# VALIDATE_BASH_EXEC: true
# VALIDATE_EDITORCONFIG: true
VALIDATE_MARKDOWN: true
VALIDATE_YAML: true
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17 changes: 0 additions & 17 deletions .github/workflows/spell-checker.yml

This file was deleted.

46 changes: 39 additions & 7 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,43 @@
---
default_stages: [commit, push]
default_language_version:
# force all unspecified Python hooks to run python3
python: python3
minimum_pre_commit_version: "1.20.0"
repos:
- repo: local
- repo: meta
hooks:
- id: identity
- id: check-hooks-apply
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.4.0
hooks:
- id: check-case-conflict
- id: check-merge-conflict
- id: check-yaml
- id: end-of-file-fixer
- id: fix-byte-order-marker
- id: mixed-line-ending
- id: trailing-whitespace
- repo: https://github.com/jumanjihouse/pre-commit-hooks
rev: 2.1.5
hooks:
- id: shellcheck
# - repo: git://github.com/Lucas-C/pre-commit-hooks
# rev: v1.1.9
# hooks:
# - id: forbid-tabs
# - id: remove-tabs
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.27.1
hooks:
- id: markdownlint
name: Run markdownlint
description: "Checks the style of Markdown files."
entry: markdownlint
language: node
types: [markdown]
files: \.(md|mdown|markdown)$
additional_dependencies: ['markdownlint-cli']
entry: markdownlint -c .github/linters/.markdown-lint.yml .
- repo: https://github.com/adrienverge/yamllint
rev: v1.26.1
hooks:
- id: yamllint
name: Check YAML files with yamllint
entry: yamllint --strict -c .github/linters/.yaml-lint.yml .
types: [yaml]
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ create-dirs:
install -d -m ${DIRMODE} ${EXTDIR}/rc.d/stop

install-bootscripts: create-dirs
install -m ${CONFMODE} clfs/rc.d/init.d/functions ${EXTDIR}/rc.d/init.d/
install -m ${CONFMODE} clfs/rc.d/init.d/functions ${EXTDIR}/rc.d/init.d/

install-bootscripts: create-dirs
install -m ${CONFMODE} clfs/rc.d/init.d/functions ${EXTDIR}/rc.d/init.d/
Expand Down
42 changes: 22 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
- [Team members](#team-members)
- [License](#license)

Donya Operating system, Yet Another Linux distro built using package management system.
Donya Operating system, Yet Another Linux distro built using a package management system.

Unlike a binary software distribution, the source code is compiled locally according to the user's preferences and is often optimized for the specific type of computer.

> This Linux distribution is not yet ready, we need the help of others. **Join team by send a message at [this issue](https://github.com/DonyaOS/Donya/issues/4)**
> This Linux distribution is not yet ready, we need the help of others. **Join the team by sending a message at [this issue](https://github.com/DonyaOS/Donya/issues/4)**
![Donya OS](images/demo.jpg)

Expand All @@ -26,13 +26,13 @@ Unlike a binary software distribution, the source code is compiled locally accor

Produced ISO file: [DonyaOS.iso](DonyaOS.iso) (In development mode)

## DonyaOS Installation guide
## DonyaOS Installation Guide

### Install Donya

Just only use compressed package `donyaOS-build.tar.xz`
Just only use the compressed package `donyaOS-build.tar.xz`

Suppose we have another hard disk `sdb` to install donyaOS on it
Suppose we have another hard disk `sdb` to install donyaOS on it.
Create a 100 MB partition in it.

![Installing DonyaOS Qemu Grub](images/qemu1.jpg)
Expand Down Expand Up @@ -114,34 +114,35 @@ udhcpd, umount, uname, uncompress, unexpand, uniq, unix2dos, unlzma,
unxz, unzip, uptime, usleep, uudecode, uuencode, vconfig, vi, watch,
watchdog, wc, wget, which, who, whoami, xargs, xz, xzcat, yes, zcat
```

## lfs donyaOS

We have build [linux from scratch](http://linuxfromscratch.org/lfs/view/stable/index.html) version of donyaOS.

[get donyaOS-lfs](https://ufile.io/sgea1rxg)

We highly recommend to use a virtual machine guest OS to save real machine.
We highly recommend using a virtual machine guest OS to save real machine.

This method tested on debian buster net-install with an extra hard disk to install **donyOS-lfs** on it.

This method testd on debian buster net-install with an extra hard disk to install donyOS-lfs on it.

We want to use `/dev/sdb` device
The extra partion is `/dev/sdb1`
We want to use `/dev/sdb` device
The extra partition is `/dev/sdb1`

- Create new partiotion on target device
- Create new partition on target device

`fdisk /dev/sdb`
with these switches
o, n, p, a

- format new partition
- format new partition

`mkfs.ext4 /dev/sdb1`

- mount partiotion
- mount partition

`mount /dev/sdb1 /mnt `
`mount /dev/sdb1 /mnt`

Copy donyaOS-lfs image to partition
Copy **donyaOS-lfs** image to partition

`cd /mnt
tar xvf ~/donyaOS_backup.tar.xz .`
Expand All @@ -150,23 +151,24 @@ tar xvf ~/donyaOS_backup.tar.xz .`

`# update-grub2`

In next boot you can login to **donyaOS-lfs** from grub menu.
In next boot you can log in to **donyaOS-lfs** from the grub menu.

![DonyaOS-lfs in VirtualBox](donyaOS-lfs.gif)

## Contribution

Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making a pull request. If you have a Donya-related project/feature/tool, add it with a pull request to this curated list!
Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making a pull request.
If you have a Donya-related project/feature/tool, add it with a pull request to this curated list!

Thank you to all the people who already contributed to DonyaOS!

**Join team by send a message at [this issue](https://github.com/DonyaOS/Donya/issues/4)**
**Join the team by sending a message at [this issue](https://github.com/DonyaOS/Donya/issues/4)**

## Team members

EsmaeelE, Prince Kumar, Emil Sayahi, Iniubong Obonguko, Hooman and Max Base
EsmaeelE, Prince Kumar, Emil Sayahi, Iniubong Obonguko, Hooman, John Bampton and Max Base

## License

MIT License Copyright (c) 2020-present, Max Base
Donya OS community
Donya OS Community
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
theme: jekyll-theme-leap-day
theme: jekyll-theme-leap-day
2 changes: 1 addition & 1 deletion donya.sh
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ sudo tar cfJ ../donyaOS-build.tar.xz ./*

#########################################################################################################

# Finish creating donyaOS
# Finish creating donyaOS

#########################################################################################################

Expand Down
Empty file added super-linter.report/.keep
Empty file.

0 comments on commit e749848

Please sign in to comment.