Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update README to point to new name #2

Merged
merged 1 commit into from
Jun 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 5 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,8 @@
this action is in maintenance-only mode and will not be accepting new features.

generally you want to use [pre-commit.ci] which is faster and has more features.

[pre-commit.ci]: https://pre-commit.ci

___

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pre-commit/action/main.svg)](https://results.pre-commit.ci/latest/github/pre-commit/action/main)
[![Build Status](https://github.com/pre-commit/action/actions/workflows/main.yml/badge.svg)](https://github.com/pre-commit/action/actions)

pre-commit/action
instrumentl/pre-commit-action
=================

a GitHub action to run [pre-commit](https://pre-commit.com)
a GitHub action to run [pre-commit](https://pre-commit.com). This was forked from [pre-commit/action](https://github.com/pre-commit/action), which
is soft-deprecated in favor of [pre-commit.ci](https://pre-commit.ci/).

### using this action

Expand All @@ -33,7 +23,7 @@ jobs:
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- uses: pre-commit/action@v3.0.1
- uses: instrumentl/pre-commit-action@v4
```

This does a few things:
Expand All @@ -51,7 +41,7 @@ Here's a sample step configuration that only runs the `flake8` hook against all
the files (use the template above except for the `pre-commit` action):

```yaml
- uses: pre-commit/action@v3.0.1
- uses: instrumentl/pre-commit-action@v4
with:
extra_args: flake8 --all-files
```
Expand Down
Loading