Skip to content
Open
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: 0 additions & 2 deletions .githooks/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,3 @@ cargo clippy $clippy_args -- --deny warnings
CARGO_BUILD_RUSTDOCFLAGS="--deny warnings" cargo doc --document-private-items --no-deps

set +x

[ $dirty_workspace -eq 0 ] && git add .
5 changes: 3 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jobs:
run: |
# TODO: rustup target add aarch64-unknown-linux-gnu
# Linting tools
cargo install cargo-shear
cargo install cargo-shear --locked
cargo fetch

- name: Build
Expand Down Expand Up @@ -120,11 +120,12 @@ jobs:
- name: Upload x86
id: upload-x86
if: ${{ steps.build.outcome == 'success' }}
uses: actions/upload-artifact@v6
uses: actions/upload-artifact@v7
with:
name: ${{ steps.create-artifacts.outputs.ARTIFACT_X86 }}
path: ${{ steps.create-artifacts.outputs.ARTIFACT_X86 }}
if-no-files-found: error
archive: false

- name: Save cached cargo dependencies
if: steps.deps-cache.outputs.cache-hit != 'true'
Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ jobs:
env:
MESSAGE_FILE: ./message.md
steps:
- uses: actions/checkout@v6

- name: Check if in PR
id: pr-number
env:
Expand Down Expand Up @@ -46,8 +48,7 @@ jobs:
if [ "${{ needs.build.outputs.build }}" == "success" ]; then
write "### :package: Artifacts:"
write "1. [Download the tarball](${{ needs.build.outputs.artifact-url }})"
write "2. \`unzip linux-enable-ir-emitter*.tar.gz.zip\`"
write "3. [Execute the install instructions](https://github.com/EmixamPP/linux-enable-ir-emitter?tab=readme-ov-file#installation)"
write "2. [Execute the install instructions](https://github.com/EmixamPP/linux-enable-ir-emitter?tab=readme-ov-file#installation)"
fi
write ""
write "## :test_tube: Tests results: $(outcome_emoji ${{ needs.build.outputs.tests }})"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ jobs:
- uses: actions/checkout@v6

- name: Download artifacts
uses: actions/download-artifact@v7
uses: actions/download-artifact@v8

- name: Create tag
uses: rickstaa/action-create-tag@v1
with:
tag: ${{ needs.build.outputs.version }}

- name: Create release
uses: softprops/action-gh-release@v2
uses: softprops/action-gh-release@v3
with:
files: linux-enable-ir-emitter-*.tar.gz
tag_name: ${{ needs.build.outputs.version }}
Expand Down
18 changes: 10 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ When building a package for distribution, please ensure the following:
```
The resulting binary will be located at `target/release/linux-enable-ir-emitter`. You can also use `cargo install --path <...>` to your convenience.
4. The v7 is incompatible with the v6. If applicable, please make sure to use the provided [migration script]() on the saved configuration.
> [!Important]
> [!IMPORTANT]
> This script is not yet available. It will be provided when the v7 will be officially released (currently in beta).

## Contributing Code
Expand All @@ -24,19 +24,21 @@ This project is using the usual Rust conventions. Here are some additional expla
cargo build
```
The resulting binary will be located at `target/debug/linux-enable-ir-emitter`

> [!NOTE]
> With a debug build, any camera can be used, even not infrared ones. This is useful for development and testing.

2. Add the pre-commit hooks to make sure the linting checks and tests are passing before each commit:
2. Run with:
```
cargo run -- <your arguments>
```
3. Add the pre-commit hooks to make sure the linting checks and tests are passing before each commit:
```
git config core.hooksPath .githooks
```
Additionally, it will automatically format/fix the issues for you when possible.
3. If you modified the UI intentionally, you will need to re-generate the UI test snapshots:
4. If you modified the UI intentionally, you will need to re-generate the UI test snapshots:
```
cargo install cargo-insta
cargo install cargo-insta --locked
cargo insta review
```
4. Please make sure to write tests for your code changes where applicable.
5. Commit, push and please describe enough what you did in your PR description. Thank you very much!
5. Please make sure to write tests for your code changes where applicable.
6. Commit, push and please describe enough what you did in your PR description. Thank you very much!
Loading
Loading