diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml new file mode 100644 index 0000000..0a7c6b1 --- /dev/null +++ b/.pre-commit-hooks.yaml @@ -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* +... diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0648835 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,28 @@ + + +# 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 diff --git a/README.md b/README.md index fb0e7ec..877135f 100644 --- a/README.md +++ b/README.md @@ -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 +... +```