mirror of
https://github.com/ivuorinen/aeonview.git
synced 2026-03-13 09:58:29 +00:00
fix: resolve MegaLinter YAML and markdown lint failures (#7)
This commit is contained in:
6
.github/CONTRIBUTING.md
vendored
6
.github/CONTRIBUTING.md
vendored
@@ -6,12 +6,14 @@ This guide will help you get started.
|
|||||||
## 🛠 Project Setup
|
## 🛠 Project Setup
|
||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/your-username/aeonview.git
|
git clone https://github.com/your-username/aeonview.git
|
||||||
cd aeonview
|
cd aeonview
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Set up your environment:
|
2. Set up your environment:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python3 -m venv venv
|
python3 -m venv venv
|
||||||
source venv/bin/activate
|
source venv/bin/activate
|
||||||
@@ -19,6 +21,7 @@ This guide will help you get started.
|
|||||||
```
|
```
|
||||||
|
|
||||||
3. Install pre-commit hooks:
|
3. Install pre-commit hooks:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pre-commit install
|
pre-commit install
|
||||||
```
|
```
|
||||||
@@ -46,17 +49,20 @@ make lint # check for lint errors
|
|||||||
## ✅ Submitting a Pull Request
|
## ✅ Submitting a Pull Request
|
||||||
|
|
||||||
1. Create a feature branch:
|
1. Create a feature branch:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git checkout -b feature/my-new-feature
|
git checkout -b feature/my-new-feature
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Commit your changes:
|
2. Commit your changes:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git add .
|
git add .
|
||||||
git commit -m "feat: add support for X"
|
git commit -m "feat: add support for X"
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Push and open a pull request:
|
3. Push and open a pull request:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git push origin feature/my-new-feature
|
git push origin feature/my-new-feature
|
||||||
```
|
```
|
||||||
|
|||||||
8
.github/workflows/pr-lint.yml
vendored
8
.github/workflows/pr-lint.yml
vendored
@@ -1,5 +1,7 @@
|
|||||||
---
|
---
|
||||||
|
# yamllint disable rule:line-length
|
||||||
# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
|
# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
|
||||||
|
# yamllint enable rule:line-length
|
||||||
name: PR Lint
|
name: PR Lint
|
||||||
|
|
||||||
# yamllint disable-line rule:truthy
|
# yamllint disable-line rule:truthy
|
||||||
@@ -20,10 +22,12 @@ jobs:
|
|||||||
name: PR Lint
|
name: PR Lint
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
contents: write # only for delete-branch option
|
contents: write # only for delete-branch option
|
||||||
issues: write
|
issues: write
|
||||||
pull-requests: write
|
pull-requests: write
|
||||||
statuses: write
|
statuses: write
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: ivuorinen/actions/pr-lint@edb5db7b564801bc35bcd5b7667c185760d05fdd # 25.4.28
|
# yamllint disable rule:line-length
|
||||||
|
- uses: ivuorinen/actions/pr-lint@edb5db7b564801bc35bcd5b7667c185760d05fdd # 25.4.28
|
||||||
|
# yamllint enable rule:line-length
|
||||||
|
|||||||
12
.github/workflows/python-tests.yml
vendored
12
.github/workflows/python-tests.yml
vendored
@@ -1,10 +1,12 @@
|
|||||||
|
---
|
||||||
name: Python tests
|
name: Python tests
|
||||||
|
|
||||||
|
# yamllint disable-line rule:truthy
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [ main, master ]
|
branches: [main, master]
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [ main, master ]
|
branches: [main, master]
|
||||||
|
|
||||||
permissions: read-all
|
permissions: read-all
|
||||||
|
|
||||||
@@ -14,10 +16,12 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
# yamllint disable-line rule:line-length
|
||||||
|
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
|
# yamllint disable-line rule:line-length
|
||||||
|
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
|
||||||
with:
|
with:
|
||||||
python-version: "3.13.2"
|
python-version: "3.13.2"
|
||||||
|
|
||||||
|
|||||||
@@ -1,39 +1,40 @@
|
|||||||
|
---
|
||||||
repos:
|
repos:
|
||||||
- repo: https://github.com/asottile/pyupgrade
|
- repo: https://github.com/asottile/pyupgrade
|
||||||
rev: v3.19.1
|
rev: v3.19.1
|
||||||
hooks:
|
hooks:
|
||||||
- id: pyupgrade
|
- id: pyupgrade
|
||||||
args: [--py3-plus]
|
args: [--py3-plus]
|
||||||
- repo: https://github.com/astral-sh/ruff-pre-commit
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||||
rev: "v0.11.5"
|
rev: "v0.11.5"
|
||||||
hooks:
|
hooks:
|
||||||
- id: ruff
|
- id: ruff
|
||||||
args: ["--fix"]
|
args: ["--fix"]
|
||||||
- id: ruff-format
|
- id: ruff-format
|
||||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
rev: v5.0.0
|
rev: v5.0.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: check-ast
|
- id: check-ast
|
||||||
- id: check-builtin-literals
|
- id: check-builtin-literals
|
||||||
- id: check-docstring-first
|
- id: check-docstring-first
|
||||||
- id: check-executables-have-shebangs
|
- id: check-executables-have-shebangs
|
||||||
- id: check-json
|
- id: check-json
|
||||||
- id: check-merge-conflict
|
- id: check-merge-conflict
|
||||||
- id: check-shebang-scripts-are-executable
|
- id: check-shebang-scripts-are-executable
|
||||||
- id: check-toml
|
- id: check-toml
|
||||||
- id: check-yaml
|
- id: check-yaml
|
||||||
- id: debug-statements
|
- id: debug-statements
|
||||||
- id: detect-aws-credentials
|
- id: detect-aws-credentials
|
||||||
- id: double-quote-string-fixer
|
- id: double-quote-string-fixer
|
||||||
- id: end-of-file-fixer
|
- id: end-of-file-fixer
|
||||||
- id: mixed-line-ending
|
- id: mixed-line-ending
|
||||||
- id: name-tests-test
|
- id: name-tests-test
|
||||||
- id: no-commit-to-branch
|
- id: no-commit-to-branch
|
||||||
- id: requirements-txt-fixer
|
- id: requirements-txt-fixer
|
||||||
- id: trailing-whitespace
|
- id: trailing-whitespace
|
||||||
- repo: https://github.com/christophmeissner/pytest-pre-commit
|
- repo: https://github.com/christophmeissner/pytest-pre-commit
|
||||||
rev: 1.0.0
|
rev: 1.0.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: pytest
|
- id: pytest
|
||||||
pass_filenames: false
|
pass_filenames: false
|
||||||
always_run: true
|
always_run: true
|
||||||
|
|||||||
Reference in New Issue
Block a user