fff70ad861
Debugging pegleg can currently be difficult and the Click CLI does not easily allow debuggers like pdb or PyCharm to use breakpoints. By moving all CLI command calls into singular functions, we can easily create an "if __name__ == '__main__'" entry point to call these functions and investigate any bugs that may arise. We also gain the ability to reuse more portions of our code by refactoring these methods. Change-Id: Ia9739931273eb6458f82dbb7e702a505ae397ae3 |
||
|---|---|---|
| doc | ||
| images/pegleg | ||
| pegleg | ||
| releasenotes | ||
| site_yamls/site | ||
| tests | ||
| tools | ||
| .dockerignore | ||
| .gitignore | ||
| .gitreview | ||
| .readthedocs.yaml | ||
| .style.yapf | ||
| .zuul.yaml | ||
| LICENSE | ||
| Makefile | ||
| Pipfile | ||
| Pipfile.lock | ||
| README.rst | ||
| requirements.txt | ||
| setup.py | ||
| tox.ini | ||
| vcs-requirements.env | ||
README.rst
Pegleg
Introduction
Pegleg is a document aggregator that provides early linting and validations via Deckhand, a document management micro-service within Airship.
Pegleg supports local and remote Git repositories. Remote repositories can be cloned using a variety of protocols -- HTTP(S) or SSH. Afterward, specific revisions within those repositories can be checked out, their documents aggregated, linted, and passed to the rest of Airship for orchestration, allowing document authors to manage their site definitions using version control.
Find more documentation for Pegleg on Read the Docs.
Core Responsibilities
- aggregation - Aggregates all documents required for site deployment across multiple Git repositories, each of which can be used to maintain separate document sets in isolation
- linting - Configurable linting checks documents for common syntactical and semantical mistakes
Getting Started
For more detailed installation and setup information, please refer to the Getting Started guide.
Integration Points
Pegleg has the following integration points: