Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lpsm-dev/gitlab-ci-lint
🔛 Simple Ruby gem that performan a Lint in your GitLab CI File
https://github.com/lpsm-dev/gitlab-ci-lint
api api-client cli docker dockerfile gem gitlab lint ruby
Last synced: 2 months ago
JSON representation
🔛 Simple Ruby gem that performan a Lint in your GitLab CI File
- Host: GitHub
- URL: https://github.com/lpsm-dev/gitlab-ci-lint
- Owner: lpsm-dev
- License: mit
- Created: 2020-04-27T13:35:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T08:38:03.000Z (about 1 year ago)
- Last Synced: 2024-10-08T14:40:21.789Z (3 months ago)
- Topics: api, api-client, cli, docker, dockerfile, gem, gitlab, lint, ruby
- Language: Ruby
- Homepage:
- Size: 88.9 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
GitLab CI Lint your CI/CD File
This is a simple project that help when you want check your GitLab CI File
Pre-Requisites |
Description |
Environment Variables |
How to contribute
## ▶️ 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!
## 🚏 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 -f
docker image build -t . (This context)
```
### Run
Steps to run the Docker Container.
* **Linux** running:
```bash
docker container run -d -p
docker container run -it --rm --name -p
```
* **Windows** running:
```
winpty docker.exe container run -it --rm
```
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
gitlab_ci_lint --help - Helper
👤 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
>
To check the change history, please access the [**CHANGELOG.md**](CHANGELOG.md) file.
This repository is a study project, therefore, it will not always be maintained 👻.
Give me a ⭐️ if this project helped you!
Made with 💜 by [me](https://github.com/lpmatos) 👋 inspired on [readme-md-generator](https://github.com/kefranabg/readme-md-generator)