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

Minor touchups. #7

Merged
merged 3 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- name: Checkout sources
uses: actions/checkout@v4
- name: Run lychee
uses: lycheeverse/lychee-action@v1.9.3
uses: lycheeverse/lychee-action@v2.0.2
with:
fail: true
spelling:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci.yaml.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Get python
uses: actions/setup-python@v3
- name: Run pre-commit check
Expand Down Expand Up @@ -46,7 +46,7 @@ jobs:
- name: Checkout sources
uses: actions/checkout@v4
- name: Run lychee
uses: lycheeverse/lychee-action@v1.9.3
uses: lycheeverse/lychee-action@v2.0.2
with:
fail: true
taplo_checks:
Expand Down
5 changes: 1 addition & 4 deletions CONTRIBUTING_FINAL.md.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ There are some things that should be kept in mind when contributing to this proj
* [`taplo`](https://github.com/tamasfe/taplo)
* [`rust-analyzer`](https://github.com/rust-lang/rust-analyzer)
{% if include_precommit -%}

### Using pre-commit hooks

This project makes use of [`pre-commit`](https://pre-commit.com/) hooks. A `pre-commit install` is recommended once the repository has been cloned, unless it has been [auto-enabled](https://pre-commit.com/#automatically-enabling-pre-commit-on-repositories).
Expand All @@ -25,25 +26,21 @@ Pretty standard procedure apart from noting that some tests may be behind featur
```sh
cargo test --all-features
```

{% if include_mdbook -%}
Book testing may be done by:

```sh
mdbook test
```
{%- endif %}

### Generating and opening documentation

```sh
cargo doc --no-deps --all-features --open
```

{% if include_mdbook -%}
Book documentation may be generated by installing [`mdbook`](https://rust-lang.github.io/mdBook/guide/installation.html) before running `mdbook serve --open`.
{%- endif %}

## Release (for maintainers)

1. Make sure CI is not failing.
Expand Down
Loading