added first draft

This commit is contained in:
Tobias Schmidl 2023-09-08 07:32:30 +02:00
parent ae30d43e22
commit bdc75fcdb0
3 changed files with 67 additions and 0 deletions

14
.pre-commit-hooks.yaml Normal file
View file

@ -0,0 +1,14 @@
# SPDX-FileCopyrightText: 2023 Tobias Schmidl
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
- id: woodpecker-lint
name: Lint Woodpecker configs
description: This hook checks against woodpecker-ci lintdo
entry: docker.io/woodpeckerci/woodpecker-cli:latest
language: docker_image
args: [lint]
types: [yaml]
files: .woodpecker.y*
...

28
CHANGELOG.md Normal file
View file

@ -0,0 +1,28 @@
<!--
SPDX-FileCopyrightText: 2023 Tobias Schmidl
SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [1.0.0] - 2023-09-08
### Added
- This CHANGELOG file
- .pre-commit-hooks.yml as a first working version
- .pre-commit-config.yml for checking this repo
- A README.md for answering the basic questions
- The LICENSES folder
- A .gitignore file
[unreleased]: https://git.schmidl.dev/schtobia/woodpecker-lint/compare/1.0.0...master
[1.0.0]: https://git.schmidl.dev/schtobia/woodpecker-lint/src/tag/1.0.0

View file

@ -7,3 +7,28 @@ SPDX-License-Identifier: AGPL-3.0-or-later
# woodpecker-lint
This repository is intended to be used as a [pre-commit hook](https://pre-commit.com/#install).
## Versioning
This repository adheres to [SemVer](https://semver.org/lang/de/) and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## Usage
Simple, add the second option to your `.pre-commit-config.yaml`.
```yaml
---
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
- id: check-merge-conflict
- repo: https://git.schmidl.dev/schtobia/woodpecker-lint
rev: v1.0.0
hooks:
- id: woodpecker-lint
...
```