Setup Documentation, GitHub Actions workflows, linting, and styling standards for NM actions

.github/pull_request_template.md

@@ -1,6 +1,15 @@
-SUMMARY:
-"please provide a brief summary"
+## Summary:
 
-TEST PLAN:
-"please outline how the changes were tested"
+Short paragraph detailing the pull request changes and reasoning in addition to any relevant context.
 
+## Details:
+
+- Detailed list of changes made in the pull request
+
+## Test Plan:
+
+- Detailed list of steps to test the changes made in the pull request
+
+## Related Issues:
+
+- List of related issues or other pull requests; ex: "Fixes #1234"

.github/workflows/hygiene.yml

@@ -0,0 +1,19 @@
+---
+name: hygiene checks
+
+on:
+  push: null
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install dependencies
+        run: pip install tox
+      - name: Run quality checks
+        run: tox -e quality

.gitignore

@@ -0,0 +1,164 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+*.swp
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.mdformat.toml

@@ -0,0 +1,3 @@
+wrap = "no"
+number = true
+end_of_line = "lf"

.yamlfix.toml

@@ -0,0 +1,17 @@
+allow_duplicate_keys = false
+comments_min_spaces_from_content = 2
+comments_require_starting_space = true
+whitelines = 1
+comments_whitelines = 1
+section_whitelines = 1
+explicit_start = true
+sequence_style = "flow_style"
+indent_mapping = 2
+ident_offset = 2
+indent_sequence = 4
+line_length = 88
+none_representation = "null"
+quote_basic_values = false
+quote_keys_and_basic_values = false
+quote_representation = "'"
+preserve_quotes = false

README.md

@@ -1,2 +1,79 @@
-# Neural Magic Actions
-Actions for Neural Magic GHA
+# NM GitHub Actions
+
+### Curated collection of commonly used GitHub Actions and workflows within Neural Magic's and vLLM's Processes
+
+## Overview
+
+This repository hosts a collection of GitHub Actions developed and maintained by Neural Magic. These actions aim to improve automation, CI/CD pipelines, and workflow orchestration. They are designed for performance, scalability, and ease of use and support a range of deployment, testing, and optimization workflows.
+
+### Key Actions
+
+- Coming soon
+
+Each action supports various configurable arguments to tailor the workflows to your project needs.
+
+## Getting Started
+
+To start using one of our GitHub Actions, include the relevant action within your workflow configuration file:
+
+```yaml
+name: Example Workflow
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v2
+
+    - name: ACTION
+      uses: neuralmagic/nm-actions/ACTION@main
+      with:
+        config-file: .eslintrc
+```
+
+This example shows how to integrate an NM action into a workflow. Visit each action's README for more configuration options and examples.
+
+## Development
+
+To contribute to NM Public Actions, follow these steps:
+
+1. Fork the repository.
+2. Create a new branch.
+3. Make your changes.
+4. `pip install tox` and run `tox -e quality` to ensure your changes meet the quality standards and `tox -e style` to enforce the style guide and formatting.
+5. Submit a pull request.
+
+## Resources
+
+### Documentation
+
+Each GitHub Action contains a `README.md` alongside any supporting documents. To learn more, dive into the action you'd like to use.
+
+### Releases
+
+Visit our [GitHub Releases page](https://github.com/neuralmagic/nm-actions/releases) and review the release notes to stay updated with the latest releases.
+
+### License
+
+NM Public Actions are licensed under the [Apache License 2.0](https://github.com/neuralmagic/guidellm/blob/main/LICENSE).
+
+## Community
+
+### Contribute
+
+We appreciate contributions to the code, examples, integrations, documentation, bug reports, and feature requests! To contribute:
+
+1. Fork the repository.
+2. Make your changes.
+3. Submit a pull request.
+
+### Join
+
+We invite you to join our growing community of developers, researchers, and enthusiasts passionate about LLMs and optimization. Whether you're looking for help, want to share your own experiences, or stay up to date with the latest developments, there are plenty of ways to get involved:
+
+- [**Neural Magic Community Slack**](https://neuralmagic.com/community/) - Join our Slack channel to connect with other NM users and developers. Ask questions, share your work, and get real-time support.
+- [**GitHub Issues**](https://github.com/neuralmagic/nm-actions/issues) - Report bugs, request features, or browse existing issues. Your feedback helps us improve.
+- [**Subscribe to Updates**](https://neuralmagic.com/subscribe/) - Sign up for the latest news, announcements, and updates about NM Public Actions, webinars, events, and more.
+- [**Contact Us**](http://neuralmagic.com/contact/) - Use our contact form for general questions about Neural Magic or NM Public Actions.