Skip to content

Commit

Permalink
Document in README
Browse files Browse the repository at this point in the history
Signed-off-by: Carmen Bianca BAKKER <carmenbianca@fsfe.org>
  • Loading branch information
carmenbianca committed Sep 10, 2024
1 parent 4f420af commit 15861d2
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 2 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ Git. This uses [pre-commit](https://pre-commit.com/). Once you
```yaml
repos:
- repo: https://github.com/fsfe/reuse-tool
rev: v3.0.2
rev: v4.0.3
hooks:
- id: reuse
```
Expand All @@ -256,6 +256,17 @@ Then run `pre-commit install`. Now, every time you commit, `reuse lint` is run
in the background, and will prevent your commit from going through if there was
an error.

If you instead want to only lint files that were changed in your commit, you can
use the following configuration:

```yaml
repos:
- repo: https://github.com/fsfe/reuse-tool
rev: v4.0.3
hooks:
- id: reuse-lint-file
```

## Maintainers

- Carmen Bianca Bakker <carmenbianca@fsfe.org>
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
# The full version, including alpha/beta/rc tags.
release = get_version("reuse")
except PackageNotFoundError:
release = "3.0.2"
release = "4.0.3"

# The short X.Y.Z version.
version = ".".join(release.split(".")[:3])
Expand Down
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,12 @@ push = false
"src/reuse/__init__.py" = [
'__version__ = "{pep440_version}"$',
]
"docs/conf.py" = [
'release = "{pep440_version}"$',
]
"README.md" = [
'rev: {version}$',
]

[tool.protokolo]
changelog = "CHANGELOG.md"
Expand Down

0 comments on commit 15861d2

Please sign in to comment.