▶️ Getting Started
Starting with git clone:
git clone --depth 1 https://github.com/lpmatos/gitlab-ci-lint.git -b master
This will give access on your local machine to this project.
☕ Buy me a coffee
Pull requests are welcome. If you'd like to support the work and buy me a ☕, I greatly appreciate it!
🚏 Pre-requisites
To this project you yeed:
- Ruby.
- Docker.
- Docker Compose.
- Install all Dependencies.
Gem Steps
gem build .\gitlab.gemspec
gem install .\gitlab-ci-lint-0.1.2.gem
gem push .\gitlab-ci-lint-0.1.2.gem
Environment variables
| Name | Description |
|---|---|
| GITLAB_ENDPOINT | GitLab API Lint Endpoint |
| GITLAB_CI_FILE | GitLab CI File |
| VALUES | Values File |
| LOG_FILE | Log File |
🐋 Development with Docker
Steps to build the Docker Image.
Build
docker image build -t <IMAGE_NAME> -f <PATH_DOCKERFILE> <PATH_CONTEXT_DOCKERFILE>
docker image build -t <IMAGE_NAME> . (This context)
Run
Steps to run the Docker Container.
- Linux running:
docker container run -d -p <LOCAL_PORT:CONTAINER_PORT> <IMAGE_NAME> <COMMAND>
docker container run -it --rm --name <CONTAINER_NAME> -p <LOCAL_PORT:CONTAINER_PORT> <IMAGE_NAME> <COMMAND>
- Windows running:
winpty docker.exe container run -it --rm <IMAGE_NAME> <COMMAND>
For more information, access the Docker documentation or this.
🐋 Development with Docker Compose
Build and run a docker-compose.
docker-compose up --build
Down all services deployed by docker-compose.
docker-compose down
Down all services and delete all images.
docker-compose down --rmi all
📣 Usage
gitlab_ci_lint --help - Helper
➤ Author
👤 Hey!! If you like this project or if you find some bugs feel free to contact me in my channels:
- Linktree: https://linktr.ee/lpmatos
➤ Versioning
To check the change history, please access the CHANGELOG.md file.
➤ Project status
This repository is a study project, therefore, it will not always be maintained 👻.
➤ Donations
➤ Show your support
Give me a ⭐️ if this project helped you!
Made with 💜 by me 👋 inspired on readme-md-generator