55d0961410
It is possible for Pegleg to generate a commit on top of a repo if the repo is dirty (aka, has uncommited/untracked files). This effectively makes the repo appear "clean", and also changes the head of the repo. This can potentially interfere with the deployment_data generation that analyzes the cleanliness of the repo as well as the commit at the head of the repo. This patch set updates the deployment_data generation logic, to be able to detect Pegleg-generated commits at the head of a repo, and instead go off of the Pegleg-generated commit's parent commit when generating the data. It also ensures the repo in the data is always marked dirty if a Pegleg-generated commit is seen, because the Pegleg-generated commit would not exist unless the repo was dirty. Change-Id: I863b3f2f661f11c36ba939ee3023f78733021b96 |
||
---|---|---|
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: