Skip to content

Commit 1012eb2

Browse files
authored
Merge pull request #93 from AGH-CEAI/feature/migrate_pre-commit_to_prek
pre-commit migration to prek
2 parents 0c5a5d9 + fc4dea9 commit 1012eb2

File tree

3 files changed

+16
-12
lines changed

3 files changed

+16
-12
lines changed

.github/workflows/pre-commit.yaml

Lines changed: 0 additions & 11 deletions
This file was deleted.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Pre-commit (Prek)
3+
4+
on: [push]
5+
6+
jobs:
7+
prek:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v6
11+
- uses: j178/prek-action@v1

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
44
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
5+
[![prek](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json)](https://github.com/j178/prek)
56
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17018771.svg)](https://doi.org/10.5281/zenodo.17018771)
67

78
A complete suite of ROS 2 packages for the Aegis UR5e cobot station.
@@ -95,10 +96,13 @@ See the [aegis_utils](./aegis_utils/README.md) package.
9596
---
9697
## Development notes
9798

98-
This project uses various tools for aiding the quality of the source code. Currently most of them are executed by the `pre-commit`. Please make sure to enable its hooks:
99+
This project uses various tools for aiding the quality of the source code. Currently most of them are executed by the `pre-commit`. As a faster alternative it is suggested to use `prek`. Please make sure to enable its hooks:
99100

100101
```bash
102+
# In case of pre-commit
101103
pre-commit install
104+
# In case of prek
105+
prek install
102106
```
103107

104108
---

0 commit comments

Comments
 (0)