Skip to content

Commit

Permalink
Sync workflow with template repository again
Browse files Browse the repository at this point in the history
Now includes pre-commit instructions as well as a minor workflow update.
  • Loading branch information
arichardson committed Jan 29, 2024
1 parent 8798815 commit 2b278c0
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-pdf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
steps:
# Checkout the repository
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
submodules: recursive

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- uses: pre-commit/[email protected]
28 changes: 26 additions & 2 deletions readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ git clone --recurse-submodules https://github.com/riscv/riscv-cheri.git

=== Building the Documentation

To start the build process, run `cd ./riscv-cheri && make all`.
To start the build process, run:

```shell
cd ./riscv-cheri && make all
```

The link:Makefile[] script will check the availability of Docker on your system:

Expand All @@ -44,4 +48,24 @@ The build process utilizes several options, including theming and font settings,

=== Cleaning up

To clean up the generated files, run `make clean`. This will remove the generated PDF file.
To clean up the generated files, run:

```shell
make clean
```

This will remove the generated PDF file.

== Enabling pre-commit checks locally
The repository has some basic commit checks set up with https://pre-commit.com/[pre-commit] that will be enforced by the GitHub CI.
To ensure these checks are also run in the local repository while making changes the following command can be run:
[source,shell]
----
pip3 install pre-commit && pre-commit install
----

When enabling additional checks https://pre-commit.com/#plugins[by editing .pre-commit-config.yaml], it is recommended to run to newly added check on all files in the repository. This can be done with the following command:
[source,shell]
----
pre-commit run --all-files
----

0 comments on commit 2b278c0

Please sign in to comment.