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.

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

Fixes issue #16 with GitHub Actions for remote and local #85

Closed
wants to merge 14 commits into from

Conversation

unixwzrd
Copy link

@unixwzrd unixwzrd commented Feb 8, 2025

I think this might be better for CI/CD pipeline, it:

  • Written for maximum compatibility, no need to install additional software (like node.js)
  • Runs pre-commit checks automatically on both:
    • Local commits (through git hooks)
    • GitHub Actions (on PRs and pushes)
  • Runs on local repository clones without requiring Python/pre-commit package
  • Sorts entries by name (case-insensitive)
  • Deduplicates URLs automatically and reports removed duplicates to STDERR
  • Reports case-insensitive duplicate Names to STDERR (but keeps them)
  • Allows commits to proceed even with warnings
  • Easy setup:
    • GitHub Actions workflow runs automatically
    • Local setup needs just 3 commands (see README

The script is stored in .github/scripts/ following GitHub best practices and uses pure bash/awk for maximum compatibility.

Currently checking the first URL (crawlerStart), but can be easily modified to check the last URL (crawlerPrefix).

Future considerations:

  • Could add HTTPS validation, though some sites might still require HTTP
  • Could add URL accessibility checks (though this might slow down commits)

Also added to the docs:

@unixwzrd unixwzrd marked this pull request as ready for review February 8, 2025 12:38
@unixwzrd unixwzrd changed the title Fixed this issue with GitHub Actions for remote and local Fixes issue #16 with GitHub Actions for remote and local Feb 10, 2025
@unixwzrd
Copy link
Author

@danperks Hey, saw this one and got busy on it. I noticed another had been submitted requiring node.js and was in conflict with the current branch.

Thanks for getting the MLX stage in there, I also included a listing for the OpenAI Cookbook with this PR as well.

Let me know if you have any questions about the CI/CD GitHub Actions, I implemented them in my personal clone fo this repository.

@danperks
Copy link
Collaborator

Hey, appreciate the work you have put in here!
My guess is having some CI here would likely be overkill - I'm shortly going to manually sort the list and hope people keep it in line, but I appreciate your desire to clean things up <3

@danperks danperks closed this Feb 16, 2025
@unixwzrd
Copy link
Author

Ok, well, it did a nice job of sorting and getting duplicate names (case-less) and URL's and highlighted conflicts. But consider it sometime if you get tired of manually doing it manual process, personally I like that it ran locally and within Cursor as well as command line. But anyway. Noticed you removed MLX - Apple Metal project which does NumPy/PyTorch/TensorFlow functions for Apple Silicon., I'll add it back in and send a PR.

Let me know if I can do anything to help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants