tmp

This is essentially my testing and proving ground for GitHub Actions usage.

Maybe it's temporary or maybe it's not. 😆

Test Content for Testing GitHub Actions

• 1
• 2
• 3
• 4
• 5

1. foo
2. bar
3. baz
4. qux
5. quux

---

Dockerfile Linting

Is Dockerfile linting super useful? Maybe, maybe not so much.

• https://github.com/replicatedhq/dockerfilelint
  • Node.js (Javascript)
  • GH Action - https://github.com/marketplace/actions/docker-lint
• https://github.com/hadolint/hadolint
  • Haskell
  • GH Action - https://github.com/marketplace/actions/hadolint-action

Hyperlink / Link Checking

Some actions only support HTML which isn't conducive for checking Markdown hyperlinks!

I'm more so after validating external hyperlinks as opposed to relative links.

• link-check-action
  • requires statically defining file name
• markdown-link-check
  • deprecated? Readme refers to linkspector below
• action-linkspector
• lychee-action ⭐
  • written in Rust ⚡

Time for a broken/invalid bare link (no bare links says the MDLinter) and an invalid Markdown link. How about an invalid website too?

Markdown Linting

• https://github.com/markdownlint/markdownlint
  • Ruby
  • GH Action: https://github.com/marketplace/actions/run-markdownlint-mdl
• https://github.com/DavidAnson/markdownlint
  • Node.js (Javascript)
  • inspired by the Ruby one at the top
  • Two CLIs, second of which from the same author
    1. https://github.com/igorshubovych/markdownlint-cli (as seen below)
    2. https://github.com/DavidAnson/markdownlint-cli2
       • plenty of flexibility with globbing
       • 🎉 globbing can be added into the cli2 config file!
       • 💡 Handles unordered after ordered list items differently than the Ruby Markdown linter (tip, it's all about alignment!)
  • GH Action: https://github.com/marketplace/actions/markdownlint-cli2-action ⭐
• https://github.com/igorshubovych/markdownlint-cli
  • Node.js (Javascript)
  • this cli uses DavidAnson's project as the base
  • GH Action: https://github.com/marketplace/actions/markdown-linting-action
• https://github.com/remarkjs/remark-lint
  • JavaScript
  • GH Action https://github.com/marketplace/actions/run-remark-lint
• https://github.com/btford/write-good
  • Node.js (Javascript)
  • not exactly a MD linter?
  • GH Action: https://github.com/marketplace/actions/lint-markdown
• https://github.com/jackdewinter/pymarkdown/tree/main
  • Python
  • pypi - https://pypi.org/project/pymarkdownlnt/
  • GH Action: None?

Python Linting and Formatting

(At the moment) This is not an exhaustive list as there are other Python linters and formatters. (ex: flake8, pylint, pydocstyle, black)

• Bandit
  • Security checking
• Black
• Flake8
• Pycodestyle
• Pylint
• https://github.com/astral-sh/ruff ⭐
  • Rust
  • extremely fast
  • can lint and format based on the arguments passed to ruff
  • GH Action: https://github.com/marketplace/actions/ruff-action

Python Environment and Package Management

Package Management Tools

Virtual Environment

• venv (built-in)
• virtualenv

Package Managers

• pip
• pipx
• pipenv
• Poetry
• Rye
• uv

YAML Linting

• https://github.com/adrienverge/yamllint ⭐
  • Python
  • GH Action: https://github.com/marketplace/actions/yaml-lint