Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
dockerfiles
repo-rst
.dockerignore
CHANGELOG.rst
LICENSE
Makefile
README.rst
VERSION
check-repo.sh
check-repo.sh-latest
check-repo.sh.bak

README.rst

TTD Repo

Validation checks, to make sure to follow always the same (our) repository style guide.

Currently only rst and md are supported.

Features

  • Small Image, based on Alpine Linux.
  • Uses Tini as init.
  • Uses su-exec for setting permissions.
  • Uses grep and awk for searching and displaying

Dependencies

Installation

Pull the image:

docker pull testthedocs/ttd-repo

Usage

Run ttd-repo from the main directory of your repoitory:

docker run -it -v `pwd`:/srv testthedocs/ttd-repo [option]

Check for md:

docker run -it -v `pwd`:/srv testthedocs/ttd-repo --md

Checks

File checks for:

  • README.rst/md
  • CHANGELOG.rst/md
  • VERSION
  • Makefile
  • .dockerignore
  • .gitignore

Directory checks for:

  • dockerfiles

Contribute

Support

If you are having issues, please let us know.

License

MIT