Skip to content

Commit

Permalink
Merge pull request #2 from cytopia/docs
Browse files Browse the repository at this point in the history
Docs
  • Loading branch information
cytopia authored Jul 7, 2019
2 parents f58c054 + 79493d5 commit 4b03889
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 18 deletions.
21 changes: 13 additions & 8 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sudo: required
###
### Language
###
language: python
language: minimal


###
Expand All @@ -31,19 +31,24 @@ env:
### Install requirements
###
install:
# Get newer docker version
- while ! sudo apt-get update; do sleep 1; done
- while ! sudo apt-get -y -o Dpkg::Options::="--force-confnew" install docker-ce; do sleep 1; done
- docker version
- retry() {
for ((n=0; n<10; n++)); do
echo "[${n}] ${*}";
if eval "${*}"; then
return 0;
fi;
done;
return 1;
}


###
### Check generation changes, build and test
###
before_script:
- make lint
- while ! make build TAG=${VERSION}; do sleep 1; done
- while ! make test TAG=${VERSION}; do sleep 1; done
- retry make lint
- retry make build TAG=${VERSION}
- retry make test TAG=${VERSION}


###
Expand Down
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ ifneq (,)
.error This Makefile requires GNU Make.
endif

.PHONY: build rebuild lint test _test_version _test_run tag pull login push enter
.PHONY: build rebuild lint test _test-version _test-run tag pull login push enter

CURRENT_DIR = $(dir $(abspath $(lastword $(MAKEFILE_LIST))))

Expand All @@ -26,10 +26,10 @@ lint:
@docker run --rm -v $(CURRENT_DIR):/data cytopia/file-lint file-utf8-bom --text --ignore '.git/,.github/,tests/' --path .

test:
@$(MAKE) --no-print-directory _test_version
@$(MAKE) --no-print-directory _test_run
@$(MAKE) --no-print-directory _test-version
@$(MAKE) --no-print-directory _test-run

_test_version:
_test-version:
@echo "------------------------------------------------------------"
@echo "- Testing correct version"
@echo "------------------------------------------------------------"
Expand Down Expand Up @@ -57,7 +57,7 @@ _test_version:
fi; \
echo "Success"; \

_test_run:
_test-run:
@echo "------------------------------------------------------------"
@echo "- Testing pep8 standard"
@echo "------------------------------------------------------------"
Expand Down
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,17 @@
> [eslint](https://github.com/cytopia/docker-eslint) ****
> [file-lint](https://github.com/cytopia/docker-file-lint) ****
> [gofmt](https://github.com/cytopia/docker-gofmt) ****
> [goimports](https://github.com/cytopia/docker-goimports) ****
> [golint](https://github.com/cytopia/docker-golint) ****
> [jsonlint](https://github.com/cytopia/docker-jsonlint) ****
> [phpcbf](https://github.com/cytopia/docker-phpcbf) ****
> [phpcs](https://github.com/cytopia/docker-phpcs) ****
> [php-cs-fixer](https://github.com/cytopia/docker-php-cs-fixer) ****
> [pycodestyle](https://github.com/cytopia/docker-pycodestyle) ****
> [pylint](https://github.com/cytopia/docker-pylint) ****
> [terraform-docs](https://github.com/cytopia/docker-terraform-docs) ****
> [terragrunt](https://github.com/cytopia/docker-terragrunt) ****
> [terragrunt-fmt](https://github.com/cytopia/docker-terragrunt-fmt) ****
> [yamllint](https://github.com/cytopia/docker-yamllint)

Expand Down Expand Up @@ -71,20 +75,26 @@ linter below for reproducible local or remote CI tests:
|--------------|------|-------------|
| [awesome-ci](https://github.com/cytopia/awesome-ci) | Basic | Tools for git, file and static source code analysis |
| [file-lint](https://github.com/cytopia/docker-file-lint) | Basic | Baisc source code analysis |
| [jsonlint](https://github.com/cytopia/docker-jsonlint) | Basic | Lint JSON files |
| [jsonlint](https://github.com/cytopia/docker-jsonlint) | Basic | Lint JSON files **<sup>[1]</sup>** |
| [yamllint](https://github.com/cytopia/docker-yamllint) | Basic | Lint Yaml files |
| [ansible](https://github.com/cytopia/docker-ansible) | Ansible | Multiple versoins of Ansible |
| [ansible-lint](https://github.com/cytopia/docker-ansible-lint) | Ansible | Lint Ansible |
| [gofmt](https://github.com/cytopia/docker-gofmt) | Go | Format Go source code |
| [gofmt](https://github.com/cytopia/docker-gofmt) | Go | Format Go source code **<sup>[1]</sup>** |
| [goimports](https://github.com/cytopia/docker-goimports) | Go | Format Go source code **<sup>[1]</sup>** |
| [golint](https://github.com/cytopia/docker-golint) | Go | Lint Go code |
| [eslint](https://github.com/cytopia/docker-eslint) | Javascript | Lint Javascript code |
| [checkmake](https://github.com/cytopia/docker-checkmake) | Make | Lint Makefiles |
| [phpcs](https://github.com/cytopia/docker-phpcs) | PHP | PHPCodeSniffer and Code Beautifier and Fixer |
| [phpcbf](https://github.com/cytopia/docker-phpcbf) | PHP | PHP Code Beautifier and Fixer |
| [phpcs](https://github.com/cytopia/docker-phpcs) | PHP | PHP Code Sniffer |
| [php-cs-fixer](https://github.com/cytopia/docker-php-cs-fixer) | PHP | PHP Coding Standards Fixer |
| [black](https://github.com/cytopia/docker-black) | Python | The uncompromising Python code formatter |
| [pycodestyle](https://github.com/cytopia/docker-pycodestyle) | Python | Python style guide checker |
| [pylint](https://github.com/cytopia/docker-pylint) | Python | Python source code, bug and quality checker |
| [terraform-docs](https://github.com/cytopia/docker-terraform-docs) | Terraform | Terraform doc generator (TF 0.12 ready) |
| [terraform-docs](https://github.com/cytopia/docker-terraform-docs) | Terraform | Terraform doc generator (TF 0.12 ready) **<sup>[1]</sup>** |
| [terragrunt](https://github.com/cytopia/docker-terragrunt) | Terraform | Terragrunt and Terraform |
| [terragrunt-fmt](https://github.com/cytopia/docker-terragrunt-fmt) | Terraform | `terraform fmt` for Terragrunt files **<sup>[1]</sup>** |

> **<sup>[1]</sup>** Uses a shell wrapper to add **enhanced functionality** not available by original project.

### Makefiles
Expand All @@ -93,7 +103,6 @@ Visit **[cytopia/makefiles](https://github.com/cytopia/makefiles)** for dependen
The provided Makefiles will only require GNU Make and Docker itself removing the need to install anything else.



## License

**[MIT License](LICENSE)**
Expand Down

0 comments on commit 4b03889

Please sign in to comment.