Skip to content
GitLab
Explore
Sign in
Register
Commits on Source (3)
docs: add usage information for all components
· 5096e284
Thomas Börger
authored
Feb 23, 2024
5096e284
feat: do not use latest version
· 2839121a
Thomas Börger
authored
Feb 27, 2024
2839121a
chore: release 1.3.0
· ea4e33d9
semantic-release-bot
authored
Feb 27, 2024
ea4e33d9
Hide whitespace changes
Inline
Side-by-side
CHANGELOG.md
View file @
ea4e33d9
# Changelog
## [1.3.0](https://git.cloudpunks.io/components/linting/compare/v1.2.0...v1.3.0) (2/27/2024)
### Features
*
do not use latest version (
[
2839121
](
https://git.cloudpunks.io/components/linting/commit/2839121abe250c1e7e51158d1fc7863121e67f35
)
)
## [1.2.0](https://git.cloudpunks.io/components/linting/compare/v1.1.0...v1.2.0) (2/23/2024)
...
...
README.md
View file @
ea4e33d9
...
...
@@ -10,6 +10,8 @@ applied by Gitlab CI on every push to the `main` branch.
## Usage
### commitlint
```
yaml
include
:
-
component
:
git.cloudpunks.io/components/linting/commitlint@main
...
...
@@ -19,14 +21,55 @@ include:
stages
:
[
linting
,
development
,
staging
,
production
]
```
### Inputs
###
#
Inputs
| Name | Default | Description |
| ---- | ------- | ----------- |
|
`as`
|
`linting:commitlint`
| Defines the name of this step within the pipeline |
|
`stage`
|
`linting`
| The pipeline stage where to add the commitlint job |
|
`image`
|
`ghcr.io/cloudpunks/commitlint:latest`
| The container which should be used to execute the job |
|
`config`
|
`/etc/commitlint.config.js`
| The path to the commitlint configuration file |
### ansible
```
yaml
include
:
-
component
:
git.cloudpunks.io/components/linting/ansible@main
inputs
:
stage
:
linting
stages
:
[
linting
,
development
,
staging
,
production
]
```
#### Inputs
| Name | Default | Description |
| ---- | ------- | ----------- |
|
`as`
|
`linting:commitlint`
| Defines the name of this step within the pipeline |
|
`stage`
|
`linting`
| The pipeline stage where to add the ansible lint job |
|
`image`
|
`ghcr.io/toolhippie/ansible-later:latest`
| The container which should be used to execute the job |
|
`config`
|
`.later.yml`
| The path to the ansible-later configuration file |
### terraform
```
yaml
include
:
-
component
:
git.cloudpunks.io/components/linting/terraform@main
inputs
:
stage
:
linting
stages
:
[
linting
,
development
,
staging
,
production
]
```
#### Inputs
| Name | Default | Description |
| ---- | ------- | ----------- |
|
`as`
|
`linting:commitlint`
| Defines the name of this step within the pipeline |
|
`stage`
|
`linting`
| The pipeline stage where to add the terraform lint job |
|
`image`
|
`hashicorp/terraform:1.7.4`
| The container which should be used to execute the job |
|
`directory`
|
`${CI_PROJECT_DIR}`
| The root path where terraform got to be executed at |
## Contact
-
Thomas Boerger, tboerger@cloudpunks.de, +49 176 81 028 021
...
...
templates/ansible.yml
View file @
ea4e33d9
...
...
@@ -8,7 +8,7 @@ spec:
default
:
linting
image
:
description
:
The container which should be used to execute the job
default
:
ghcr.io/toolhippie/ansible-later:
latest
default
:
ghcr.io/toolhippie/ansible-later:
4.0.1
config
:
description
:
The path to the ansible-later configuration file
default
:
.later.yml
...
...