gitlab-ci-lint 0.1.3 → 0.1.4

data/.gitlab-ci.yml

@@ -1,72 +1,72 @@
-# ==============================================================================
-# STAGES
-# ==============================================================================
-
-stages: [ .pre, build, merge, chatops ]
-
-# ==============================================================================
-# DEFAULT IMAGE AND SERVICES
-# ==============================================================================
-
-default:
-  image: docker:19.03.0
-  services:
-    - docker:19.03.0-dind
-  timeout: 1h 30m
-
-# ==============================================================================
-# WORKFLOW RULES
-# ==============================================================================
-
-workflow:
-  rules:
-    - if: $PIPELINE_DISABLE == "true"
-      when: never
-    - if: '$CI_PIPELINE_SOURCE =~ /^(trigger|merge_request_event)$/'
-      when: never
-    - when: always
-
-# ==============================================================================
-# GLOBAL VARIABLES
-# ==============================================================================
-
-variables:
-  GIT_DEPTH: "20"
-  GIT_SUBMODULE_STRATEGY: "none"
-  DOCKER_HOST: tcp://localhost:2375
-  DOCKER_TLS_CERTDIR: ""
-  DOCKER_DRIVER: overlay2
-  DOCKER_BUILDKIT: 1
-
-# =============================================================================
-# JOB MERGE REQUEST
-# =============================================================================
-
-job:merge:
-  stage: merge
-  script:
-    - echo "Check Project Structure."
-  only:
-    refs:
-      - merge_requests
-
-# =============================================================================
-# JOB CHATOPS
-# =============================================================================
-
-echo:
-  image: registry.stefanini.io/shared/devops/deploy/k8s:latest
-  stage: chatops
-  only: [chat]
-  before_script:
-    - echo "Configure Kubeconfig"
-    - echo ${KUBECONFIG_CLUSTER_PROD} | base64 -d > ${HOME}/.kube/config
-  script:
-    - echo "Your input was - ${CHAT_INPUT}. This command will not be shown."
-    - |
-      if [ -z "${CHAT_INPUT}" ]
-      then
-        echo -e "section_start:$( date +%s ):chat_reply\r\033[0K\nNothing to Do...\nsection_end:$( date +%s ):chat_reply\r\033[0K"
-      else
-        echo -e "section_start:$( date +%s ):chat_reply\r\033[0K\n$( ${CHAT_INPUT} )\nsection_end:$( date +%s ):chat_reply\r\033[0K"
-      fi
+# ==============================================================================
+# STAGES
+# ==============================================================================
+
+stages: [ .pre, build, merge, chatops ]
+
+# ==============================================================================
+# DEFAULT IMAGE AND SERVICES
+# ==============================================================================
+
+default:
+  image: docker:19.03.0
+  services:
+    - docker:19.03.0-dind
+  timeout: 1h 30m
+
+# ==============================================================================
+# WORKFLOW RULES
+# ==============================================================================
+
+workflow:
+  rules:
+    - if: $PIPELINE_DISABLE == "true"
+      when: never
+    - if: '$CI_PIPELINE_SOURCE =~ /^(trigger|merge_request_event)$/'
+      when: never
+    - when: always
+
+# ==============================================================================
+# GLOBAL VARIABLES
+# ==============================================================================
+
+variables:
+  GIT_DEPTH: "20"
+  GIT_SUBMODULE_STRATEGY: "none"
+  DOCKER_HOST: tcp://localhost:2375
+  DOCKER_TLS_CERTDIR: ""
+  DOCKER_DRIVER: overlay2
+  DOCKER_BUILDKIT: 1
+
+# =============================================================================
+# JOB MERGE REQUEST
+# =============================================================================
+
+job:merge:
+  stage: merge
+  script:
+    - echo "Check Project Structure."
+  only:
+    refs:
+      - merge_requests
+
+# =============================================================================
+# JOB CHATOPS
+# =============================================================================
+
+echo:
+  image: registry.stefanini.io/shared/devops/deploy/k8s:latest
+  stage: chatops
+  only: [chat]
+  before_script:
+    - echo "Configure Kubeconfig"
+    - echo ${KUBECONFIG_CLUSTER_PROD} | base64 -d > ${HOME}/.kube/config
+  script:
+    - echo "Your input was - ${CHAT_INPUT}. This command will not be shown."
+    - |
+      if [ -z "${CHAT_INPUT}" ]
+      then
+        echo -e "section_start:$( date +%s ):chat_reply\r\033[0K\nNothing to Do...\nsection_end:$( date +%s ):chat_reply\r\033[0K"
+      else
+        echo -e "section_start:$( date +%s ):chat_reply\r\033[0K\n$( ${CHAT_INPUT} )\nsection_end:$( date +%s ):chat_reply\r\033[0K"
+      fi

data/CHANGELOG.md

@@ -1,39 +1,39 @@
-# CHANGELOG
-
-All important changes to this project will be added to this file! This changelog will be based on [Keep a change log](http://keepachangelog.com/)
-
-## 0.1.2 - Core Project - [29-04-2020]
-
-### Added
-
-* Many, many features have been added.
-* Dockerfile and Docker Compose support.
-* Class:
-  * GitLab::CI::Lint::Actions.
-  * GitLab::CI::Lint::Arguments.
-  * GitLab::CI::Lint::Client.
-  * GitLab::CI::Lint::Configuration.
-  * GitLab::CI::Lint::Log.
-  * GitLab::CI::Lint::MultIO.
-  * GitLab::CI::Lint::Serializer.
-  * GitLab::CI::Lint::System.
-  * GitLab::CI::Lint::YMLReader.
-* Create a CLI to get values from bash.
-* Create a YMLReader to get values from yml files.
-* Create Client Request GitLab CI to post the content of .gitlab to the API.
-* Actions to evaluate the result.
-* Request validations.
-* YAML validations
-
-## 0.1.1 - Rakefile - [28-04-2020]
-
-### Added
-
-* Rake file modules.
-* Taks in Rakefile.
-
-## 0.1.0 - Just Initial Adding Files - [27-04-2020]
-
-### Added
-
-* Project structure.
+# CHANGELOG
+
+All important changes to this project will be added to this file! This changelog will be based on [Keep a change log](http://keepachangelog.com/)
+
+## 0.1.2 - Core Project - [29-04-2020]
+
+### Added
+
+* Many, many features have been added.
+* Dockerfile and Docker Compose support.
+* Class:
+  * GitLab::CI::Lint::Actions.
+  * GitLab::CI::Lint::Arguments.
+  * GitLab::CI::Lint::Client.
+  * GitLab::CI::Lint::Configuration.
+  * GitLab::CI::Lint::Log.
+  * GitLab::CI::Lint::MultIO.
+  * GitLab::CI::Lint::Serializer.
+  * GitLab::CI::Lint::System.
+  * GitLab::CI::Lint::YMLReader.
+* Create a CLI to get values from bash.
+* Create a YMLReader to get values from yml files.
+* Create Client Request GitLab CI to post the content of .gitlab to the API.
+* Actions to evaluate the result.
+* Request validations.
+* YAML validations
+
+## 0.1.1 - Rakefile - [28-04-2020]
+
+### Added
+
+* Rake file modules.
+* Taks in Rakefile.
+
+## 0.1.0 - Just Initial Adding Files - [27-04-2020]
+
+### Added
+
+* Project structure.

data/Dockerfile

@@ -1,35 +1,35 @@
-ARG RUBY_VERSION=2.6.5-alpine3.10
-
-FROM ruby:${RUBY_VERSION}
-
-LABEL maintainer="Lucca Pessoa da Silva Matos - luccapsm@gmail.com" \
-        org.label-schema.version="1.0.0" \
-        org.label-schema.release-data="29-04-2020" \
-        org.label-schema.url="https://github.com/lpmatos/gitlab-ci-lint" \
-        org.label-schema.ruby="https://www.ruby-lang.org/pt/" \
-        org.label-schema.gitlab="https://docs.gitlab.com/" \
-        org.label-schema.name="GitLab CI Lint"
-
-ENV HOME=/usr/src/code
-
-RUN set -ex && apk update
-
-RUN apk add --no-cache --update \
-      build-base \
-      make \
-      gcc \
-      git \
-      bash
-
-RUN mkdir -p /var/log && touch /var/log/file.log
-
-WORKDIR ${HOME}
-
-RUN gem install bundle
-
-COPY [ ".", "." ]
-
-RUN bundle install && bundle exec rake && \
-    chmod +x ./bin/gitlab_ci_lint
-
-CMD [ "ruby", "/bin/gitlab_ci_lint", "-h" ]
+ARG RUBY_VERSION=2.6.5-alpine3.10
+
+FROM ruby:${RUBY_VERSION}
+
+LABEL maintainer="Lucca Pessoa da Silva Matos - luccapsm@gmail.com" \
+        org.label-schema.version="1.0.0" \
+        org.label-schema.release-data="29-04-2020" \
+        org.label-schema.url="https://github.com/lpmatos/gitlab-ci-lint" \
+        org.label-schema.ruby="https://www.ruby-lang.org/pt/" \
+        org.label-schema.gitlab="https://docs.gitlab.com/" \
+        org.label-schema.name="GitLab CI Lint"
+
+ENV HOME=/usr/src/code
+
+RUN set -ex && apk update
+
+RUN apk add --no-cache --update \
+      build-base \
+      make \
+      gcc \
+      git \
+      bash
+
+RUN mkdir -p /var/log && touch /var/log/file.log
+
+WORKDIR ${HOME}
+
+RUN gem install bundle
+
+COPY [ ".", "." ]
+
+RUN bundle install && bundle exec rake && \
+    chmod +x ./bin/gitlab_ci_lint
+
+CMD [ "ruby", "/bin/gitlab_ci_lint", "-h" ]

data/Gemfile

@@ -1,16 +1,16 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-gemspec
-
-group :development do
-  gem "bundler"
-  gem "rake"
-  gem "rspec"
-  gem "httparty"
-  gem "OptionParser"
-  gem "yaml"
-  gem "colorize"
-  gem "pry"
-end
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development do
+  gem "bundler"
+  gem "rake"
+  gem "rspec"
+  gem "httparty"
+  gem "OptionParser"
+  gem "yaml"
+  gem "colorize"
+  gem "pry"
+end

data/Makefile

@@ -1,50 +1,50 @@
-# =============================================================================
-# DECLARING VARIABLES
-# =============================================================================
-
-# DOCKERFILE PATH
-PATH_DOCKERFILE=./Dockerfile
-
-# DOCKERFILE CONTENTX
-CONTEXT_DOCKERFILE=./
-
-# CONTAINERS
-DOCKER_CONTAINER_LIST:=$(shell docker ps -aq)
-
-# =============================================================================
-# DOCKER BUILD
-# =============================================================================
-
-build:
-	docker image build --no-cache -t gitlab-ci-lint -f ${PATH_DOCKERFILE} ${CONTEXT_DOCKERFILE}
-
-system:
-	docker system prune -af
-
-volume:
-	docker volume prune -f
-
-network:
-	docker network prune -f
-
-stop:
-	docker stop ${DOCKER_CONTAINER_LIST}
-
-remove:
-	docker rm ${DOCKER_CONTAINER_LIST}
-
-# =============================================================================
-# DOCKER-COMPOSE
-# =============================================================================
-
-compose:
-	docker-compose up --build
-
-back:
-	docker-compose up --build -d
-
-down:
-	docker-compose down
-
-delete:
-	docker-compose down --rmi all
+# =============================================================================
+# DECLARING VARIABLES
+# =============================================================================
+
+# DOCKERFILE PATH
+PATH_DOCKERFILE=./Dockerfile
+
+# DOCKERFILE CONTENTX
+CONTEXT_DOCKERFILE=./
+
+# CONTAINERS
+DOCKER_CONTAINER_LIST:=$(shell docker ps -aq)
+
+# =============================================================================
+# DOCKER BUILD
+# =============================================================================
+
+build:
+	docker image build --no-cache -t gitlab-ci-lint -f ${PATH_DOCKERFILE} ${CONTEXT_DOCKERFILE}
+
+system:
+	docker system prune -af
+
+volume:
+	docker volume prune -f
+
+network:
+	docker network prune -f
+
+stop:
+	docker stop ${DOCKER_CONTAINER_LIST}
+
+remove:
+	docker rm ${DOCKER_CONTAINER_LIST}
+
+# =============================================================================
+# DOCKER-COMPOSE
+# =============================================================================
+
+compose:
+	docker-compose up --build
+
+back:
+	docker-compose up --build -d
+
+down:
+	docker-compose down
+
+delete:
+	docker-compose down --rmi all

data/README.md

@@ -1,213 +1,213 @@
-<p align="center">
-  <img alt="gitlab" src="https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcQYfhC8pImPXqjjQkZfOH2bAMltzPE5w9QMQJd8dUVqGCICbpF1&usqp=CAU" width="250px" float="center"/>
-</p>
-
-<h1 align="center">GitLab CI Lint your CI/CD File</h1>
-
-<p align="center">
-  <strong>This is a simple project that help when you want check your GitLab CI File</strong>
-</p>
-
-<p align="center">
-  <a href="https://github.com/lpmatos/gitlab-ci-lint">
-    <img alt="Open Source" src="https://badges.frapsoft.com/os/v1/open-source.svg?v=102">
-  </a>
-
-  <a href="https://github.com/lpmatos/gitlab-ci-lint/graphs/contributors">
-    <img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/lpmatos/gitlab-ci-lint">
-  </a>
-
-  <a href="https://github.com/lpmatos/gitlab-ci-lint">
-    <img alt="GitHub Language Count" src="https://img.shields.io/github/languages/count/lpmatos/gitlab-ci-lint">
-  </a>
-
-  <a href="https://github.com/lpmatos/gitlab-ci-lint">
-    <img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/lpmatos/gitlab-ci-lint">
-  </a>
-
-  <a href="https://github.com/lpmatos/gitlab-ci-lint/stargazers">
-    <img alt="GitHub Stars" src="https://img.shields.io/github/stars/lpmatos/gitlab-ci-lint?style=social">
-  </a>
-
-  <a href="https://github.com/lpmatos/gitlab-ci-lint/commits/master">
-    <img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/lpmatos/gitlab-ci-lint">
-  </a>
-
-  <a href="https://github.com/lpmatos/gitlab-ci-lint">
-    <img alt="Repository Size" src="https://img.shields.io/github/repo-size/lpmatos/gitlab-ci-lint">
-  </a>
-
-  <a href="https://github.com/lpmatos/gitlab-ci-lint/issues">
-    <img alt="Repository Issues" src="https://img.shields.io/github/issues/lpmatos/gitlab-ci-lint">
-  </a>
-
-  <a href="https://github.com/lpmatos/gitlab-ci-lint/blob/master/LICENSE">
-    <img alt="MIT License" src="https://img.shields.io/github/license/lpmatos/gitlab-ci-lint">
-  </a>
-</p>
-
-<p align="center">
-  <a href="#pre-requisites">Pre-Requisites</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
-  <a href="#description">Description</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
-  <a href="#environment-variables">Environment Variables</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
-  <a href="#how-to-contribute">How to contribute</a>
-</p>
-
-## ▶️ Getting Started
-
-Starting with **git clone**:
-
-```bash
-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!
-
-<a href="https://www.buymeacoffee.com/EatdMck" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 100px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
-
-## 🚏 Pre-requisites
-
-To this project you yeed:
-
-- Ruby.
-- Docker.
-- Docker Compose.
-- Install all Dependencies.
-
-## Gem Steps
-
-```bash
-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
-
-```bash
-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:
-
-```bash
-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](https://docs.docker.com/) documentation or [this](docs/annotations/docker.md).
-
-## 🐋 Development with Docker Compose
-
-Build and run a docker-compose.
-
-```bash
-docker-compose up --build
-```
-
-Down all services deployed by docker-compose.
-
-```bash
-docker-compose down
-```
-
-Down all services and delete all images.
-
-```bash
-docker-compose down --rmi all
-```
-
-## 📣 Usage
-
-<kbd>gitlab_ci_lint --help</kbd> - Helper
-
-## 🎒 How to contribute
-
-1. Make a **Fork**.
-2. Follow the project organization.
-3. Add the file to the appropriate level folder - If the folder does not exist, create according to the standard.
-4. Make the **Commit**.
-5. Open a **Pull Request**.
-6. Wait for your pull request to be accepted.. 🚀
-
-Remember: There is no bad code, there are different views/versions of solving the same problem. 😊
-
-## 🔔 Add to git and push
-
-You must send the project to your GitHub after the modifications
-
-```bash
-git add -f .
-git commit -m "Added - Fixing somethings"
-git push origin master
-```
-
-## 📋 Versioning
-
-- [CHANGELOG](CHANGELOG.md)
-
-## 📜 License
-
-Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
-
-## ☎️ Contacts
-
-Hey!! If you like this project or if you find some bugs feel free to contact me in my channels:
-
-* **Email**: luccapsm@gmail.com
-* **Linkedin**: www.linkedin.com/in/lucca-pessoa-4abb71138/
-
-[![Facebook](https://github.frapsoft.com/social/facebook.png)](https://www.facebook.com/lucca.pessoa.9)
-[![Github](https://github.frapsoft.com/social/github.png)](https://github.com/lpmatos)
-
-## ✨ Contributors
-
-<table>
-  <tr>
-    <td align="center"><a href="https://github.com/lpmatos"><img src="https://avatars2.githubusercontent.com/u/58797390?s=400&v=4" width="100px;" alt=""/><br /><sub><b>Lucca Pessoa</b></sub></a><br /><a href="https://github.com/lpmatos/gitlab-ci-lint/commits?author=lpmatos" title="Code">💻</a></a></td>
-  <tr>
-</table>
-
-## 🐯 Autor
-
-<table>
-  <tr>
-    <td align="center"><a href="https://github.com/lpmatos"><img src="https://avatars2.githubusercontent.com/u/58797390?s=400&v=4" width="100px;" alt=""/><br /><sub><b>Lucca Pessoa</b></sub></a><br /><a href="https://github.com/lpmatos/gitlab-ci-lint/commits?author=lpmatos" title="Code">💻</a> <a href="https://github.com/lpmatos/gitlab-ci-lint/commits?author=lpmatos" title="Design">🎨</a></td>
-  <tr>
-</table>
-
-## Project Status
-
-* 🔛 In production
-
----
-
-<p align="center">Feito com ❤️ by <strong>Lucca Pessoa :wave:</p>
+<p align="center">
+  <img alt="gitlab" src="https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcQYfhC8pImPXqjjQkZfOH2bAMltzPE5w9QMQJd8dUVqGCICbpF1&usqp=CAU" width="250px" float="center"/>
+</p>
+
+<h1 align="center">GitLab CI Lint your CI/CD File</h1>
+
+<p align="center">
+  <strong>This is a simple project that help when you want check your GitLab CI File</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/lpmatos/gitlab-ci-lint">
+    <img alt="Open Source" src="https://badges.frapsoft.com/os/v1/open-source.svg?v=102">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint/graphs/contributors">
+    <img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint">
+    <img alt="GitHub Language Count" src="https://img.shields.io/github/languages/count/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint">
+    <img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint/stargazers">
+    <img alt="GitHub Stars" src="https://img.shields.io/github/stars/lpmatos/gitlab-ci-lint?style=social">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint/commits/master">
+    <img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint">
+    <img alt="Repository Size" src="https://img.shields.io/github/repo-size/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint/issues">
+    <img alt="Repository Issues" src="https://img.shields.io/github/issues/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint/blob/master/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/lpmatos/gitlab-ci-lint">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#pre-requisites">Pre-Requisites</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#description">Description</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#environment-variables">Environment Variables</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#how-to-contribute">How to contribute</a>
+</p>
+
+## ▶️ Getting Started
+
+Starting with **git clone**:
+
+```bash
+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!
+
+<a href="https://www.buymeacoffee.com/EatdMck" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 100px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
+
+## 🚏 Pre-requisites
+
+To this project you yeed:
+
+- Ruby.
+- Docker.
+- Docker Compose.
+- Install all Dependencies.
+
+## Gem Steps
+
+```bash
+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
+
+```bash
+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:
+
+```bash
+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](https://docs.docker.com/) documentation or [this](docs/annotations/docker.md).
+
+## 🐋 Development with Docker Compose
+
+Build and run a docker-compose.
+
+```bash
+docker-compose up --build
+```
+
+Down all services deployed by docker-compose.
+
+```bash
+docker-compose down
+```
+
+Down all services and delete all images.
+
+```bash
+docker-compose down --rmi all
+```
+
+## 📣 Usage
+
+<kbd>gitlab_ci_lint --help</kbd> - Helper
+
+## 🎒 How to contribute
+
+1. Make a **Fork**.
+2. Follow the project organization.
+3. Add the file to the appropriate level folder - If the folder does not exist, create according to the standard.
+4. Make the **Commit**.
+5. Open a **Pull Request**.
+6. Wait for your pull request to be accepted.. 🚀
+
+Remember: There is no bad code, there are different views/versions of solving the same problem. 😊
+
+## 🔔 Add to git and push
+
+You must send the project to your GitHub after the modifications
+
+```bash
+git add -f .
+git commit -m "Added - Fixing somethings"
+git push origin master
+```
+
+## 📋 Versioning
+
+- [CHANGELOG](CHANGELOG.md)
+
+## 📜 License
+
+Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
+
+## ☎️ Contacts
+
+Hey!! If you like this project or if you find some bugs feel free to contact me in my channels:
+
+* **Email**: luccapsm@gmail.com
+* **Linkedin**: www.linkedin.com/in/lucca-pessoa-4abb71138/
+
+[![Facebook](https://github.frapsoft.com/social/facebook.png)](https://www.facebook.com/lucca.pessoa.9)
+[![Github](https://github.frapsoft.com/social/github.png)](https://github.com/lpmatos)
+
+## ✨ Contributors
+
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/lpmatos"><img src="https://avatars2.githubusercontent.com/u/58797390?s=400&v=4" width="100px;" alt=""/><br /><sub><b>Lucca Pessoa</b></sub></a><br /><a href="https://github.com/lpmatos/gitlab-ci-lint/commits?author=lpmatos" title="Code">💻</a></a></td>
+  <tr>
+</table>
+
+## 🐯 Autor
+
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/lpmatos"><img src="https://avatars2.githubusercontent.com/u/58797390?s=400&v=4" width="100px;" alt=""/><br /><sub><b>Lucca Pessoa</b></sub></a><br /><a href="https://github.com/lpmatos/gitlab-ci-lint/commits?author=lpmatos" title="Code">💻</a> <a href="https://github.com/lpmatos/gitlab-ci-lint/commits?author=lpmatos" title="Design">🎨</a></td>
+  <tr>
+</table>
+
+## Project Status
+
+* 🔛 In production
+
+---
+
+<p align="center">Feito com ❤️ by <strong>Lucca Pessoa :wave:</p>