Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

replace 🪦 Stickler with strict linter in CI #55

Closed
5 of 11 tasks
reactive-firewall opened this issue Sep 3, 2024 · 3 comments · Fixed by #51 or #159
Closed
5 of 11 tasks

replace 🪦 Stickler with strict linter in CI #55

reactive-firewall opened this issue Sep 3, 2024 · 3 comments · Fixed by #51 or #159
Assignees
@reactive-firewall
Labels
Bash Lang Changes to the BASH scripts CI Continuous Integration Tooling GitHub Anything Meta Linter Any linter tool or setting file enhancements Python Lang Changes to Python source code question Further information is requested
Milestone
DRY/AHA Refactor

Comments

@reactive-firewall
Copy link
Owner

reactive-firewall commented Sep 3, 2024 •
edited
Loading

Replace sticklerCI features with similar lint checks.

Describe the solution you'd like

  • check code-style with various linters including:
    • flake8 checks
    • shellcheck checks
    • GitHub annotations (at-least with PRs)
    • new OPTIONALS
      • markdown linter (optional)
      • yaml-lint (optional)
      • codespell (optional)
      • makefile-linter (optional)

Describe alternatives you've considered

  • prefer the style of flake8 (based on PEP-8) over black for python.
  • does shellcheck EVEN have an alternative: Not really
  • should check if houndCI still works too
  • need to check yaml and markdown for options (optional)

Additional context

  • critical that git annotations link to some kind of reference docs on errors (even just a web search)
@reactive-firewall reactive-firewall self-assigned this Sep 3, 2024
@reactive-firewall reactive-firewall added this to the DRY/AHA Refactor milestone Sep 3, 2024
@reactive-firewall reactive-firewall added question Further information is requested Linter Any linter tool or setting file enhancements Python Lang Changes to Python source code Bash Lang Changes to the BASH scripts CI Continuous Integration Tooling GitHub Anything Meta labels Sep 3, 2024
@reactive-firewall reactive-firewall linked a pull request Sep 3, 2024 that will close this issue
Release Candidate 1.4.4 #51
Merged
21 tasks
This was referenced Sep 3, 2024
Merged
Closed
@reactive-firewall
Copy link
Owner Author

  • python bandit scan Bandit

reactive-firewall added a commit that referenced this issue Sep 10, 2024
@reactive-firewall
[DOCUMENTATION] Minor update to project README (- Fixes #72 -)
d5fad86 
Changes in file README.md:
 * Corrections
 * New badge (- WIP #55 -)
 * Minor rewording and clearifications
 * Project link for next-steps added
@reactive-firewall
Copy link
Owner Author

could easily build a tool around:

    yamllint -f github .github/**/*.yml

@reactive-firewall reactive-firewall mentioned this issue Sep 27, 2024
Merged
1 task
reactive-firewall added a commit that referenced this issue Oct 10, 2024
@reactive-firewall
[REGRESSION] fix for testing covrage regression (- WIP #55 & PR #148 -)
f82b40d 
### ChangeLog:

Changes in file multicast/hear.py:
 def handle(self):

Changes in file multicast/recv.py:
 def joinstep(groups, port, iface=None, bind_group=None, isock=None):
reactive-firewall added a commit that referenced this issue Oct 10, 2024
@reactive-firewall
[PATCH] fixes for integration testing script (- WIP #55 -)
39dda25 
Changes in file tests/check_integration_coverage:
 - fixed usage of multicast cli
 - new random port diognostics
 - some clarification comments added
reactive-firewall added a commit that referenced this issue Oct 11, 2024
@reactive-firewall
[UPGRADE] Stable Version v2.0.0-beta (Security Pre-Release)
1c9d215 
* From Security Patches (tag 'v1.5.1'):
  [SECURITY] Patch for GHSA-2v67-4x3c-889g (BACKPORT)

* From PR #148 (master):
  : Master Branch
  [SECURITY] Fix for GHSA-2v67-4x3c-889g
  [PATCH] Fixes for integration testing script (- WIP #55 -)
  [PATCH] Apply suggestions from code review (- WIP PR #148 -)
  [PATCH] FIXED readthedocs strangeness (- WIP #79  -)
  [PATCH] minor fix for the implementation of read-the-docs config
  [PATCH] cleaned up documentation regarding usage (- WIP #79 -)
  [PATCH] fixup for better tox testing (- WIP PR #135 -)
  [DOCUMENTATION] Improved docstring coverage a bunch (- WIP #79 -)
  [DOCUMENTATION] Fixes for documentation builds and version bump to 2.0.0-beta
  [DOCUMENTATION] Slight improvement to documentation (- WIP #79 -)
  [DOCUMENTATION] Resolve documentation conflict with fuzz-testing branch.
  [DOCUMENTATION] minor correction to docstrings for endSocket.
  [DOCUMENTATION] Slight improvement of meta-testing via doctests (- WIP #128 & #129 -)
  [DOCUMENTATION] improved docstrings as discussed in review (- WIP PR #137 -)
  [DOCUMENTATION] Corrected exitcode description (no code change) (- WIP #79 -)
  [DOCUMENTATION] Improved documentation as per #79
  [DOCUMENTATION] expands the documentation of the module (- WIP #79 -)
  [STYLE] applied changes from review (- WIP #146 -)
  [STYLE] Various style fixes (- WIP #141 -)
  [STYLE] Fixed Whitespace (- WIP #79 -)
  [COVERAGE] improving coverage slightly (- WIP #55 -)
  [TESTING] improved testing slightly
  [TESTING] implementing basic fuzzing (- WIP #13 -)
  [TESTING] testing simpler new-style imports
  [REGRESSION] Contributes to #53
  [HOTFIX] fix for bad labeler config (- WIP #135
  [FIX] Fix typo in tox.ini
  [UPGRADE] improved error handling by implementing error chaining (- WIP #32 -)
  [UPGRADE] Version 2.0 Development Cycle (- WIP #120 -)
@reactive-firewall
Copy link
Owner Author

💁🏻 yaml and markdown lint GHA templated in reactive-firewall/ymmv and imported over, patch incoming.

reactive-firewall added a commit that referenced this issue Oct 12, 2024
@reactive-firewall
[CI] Implemented makefile linter workflow (- WIP #55 -)
2193e33 
Changes in file .github/workflows/makefile-lint.yml:
 Unknown Changes
@reactive-firewall reactive-firewall linked a pull request Oct 12, 2024 that will close this issue
Replace stickler #159
Merged
reactive-firewall added a commit that referenced this issue Oct 14, 2024
@reactive-firewall
[MERGE] Version 2.0.0-rc0
5a7c1c1 
* From PR #158 (patch-branch-name-dyn-113):
  Fix for .github/workflows/Tests.yml
  [DOCUMENTATION] implemented dynamic branch feature for docs (- WIP #113 -)

* From PR #159 (Feature-replace-stickler):
  [PATCH] Update docs/FAQ.md
  [PATCH] Fixed some typos Part 7
  [PAATCH] Apply suggestions from code review
  [PATCH] Fixed some typos Part 6
  [PATCH] Fixed some typos Part 5
  [PATCH] Fixed some typos Part 4
  [PATCH] Fixed some typos Part 3
  [PATCH] Fixed some typos Part 2
  [PATCH] Fixed some typos
  [DOCUMENTATION] Reformated as per linter (- WIP PR #159 -)
  [DOCUMENTATION] reformated as per linter (- WIP PR #159 -)
  [DOCUMENTATION] Reformating FAQ as per linter (- WIP PR #159 -)
  [PATCH] more fixes for CI.md
  [DOCUMENTATION] Updated and reformated as per linting (- WIP #73 & PR #159 -)
  [DOCUMENTATION] reformatting markdown as per linting (- WIP PR #159 -)
  [DOCUMENTATION] reformatting markdown as per linting (- WIP #79 & PR #159 -)
  [UPDATE] Apply suggestions from code review
  [PATCH] possible fix for makefile-lint part 8
  [PATCH] possible fix for makefile-lint part 7
  [PATCH] possible fix for makefile-lint part 6
  [PATCH] possible fix for makefile-lint part 5
  [PATCH] possible fix for makefile-lint part 4
  [PATCH] possible fix for makefile-lint part 3
  [PATCH] possible fix for makefile-lint part 2
  [PATCH] possible fix for makefile-lint
  [PATCH] fix to install go-lang for checkmake (- WIP #159 -)
  Update .github/workflows/makefile-lint.yml
  Fix for .github/workflows/makefile-lint.yml
  [CI] Implemented makefile linter workflow (- WIP #55 -)
  [CI] Added yaml and markdown linting jobs to CI

* From PR #160 (patch-version-parsing):
  Minor fix for tests/check_pip
  [TESTING] Implemented check_command in test scripts (- WIP #126 -)
  [TESTING] Implemented idea to use packaging to parse PEP 440 versions (- WIP #156 -)
  [TESTING] Use version to parse versions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@reactive-firewall reactive-firewall

Labels
Bash Lang Changes to the BASH scripts CI Continuous Integration Tooling GitHub Anything Meta Linter Any linter tool or setting file enhancements Python Lang Changes to Python source code question Further information is requested
Projects
Multicast Project
Status: Done
Milestone
DRY/AHA Refactor
1 participant
@reactive-firewall