Skip to content

anttiharju/compare-changes

Repository files navigation

compare-changes

Build

Takes the name of a wildcard workflow (* in .github/workflows/wildcard-* incl. file extension) and a JSON array generated with find-changes-action as inputs, to output true/false based on whether any of the on.push.paths of the wildcard workflow match a file in the JSON array.

This is useful to introduce job and step granularity to your workflows. One can save a lot of time (and money by reducing runner usage) by executing long-running jobs conditionally.

More information

There is additional documentation available on

Installation

Cargo

CLI

cargo install --features=cli compare-changes

Library

cargo add compare-changes

Brew

brew install anttiharju/tap/compare-changes

Nix

Via anttiharju's nur-packages. Please note that as of writing it is not connected to the upstream NUR.

TODO

  • Improve instructions on how to contribute.
  • Produce static Linux binaries for wider compatibility with GitHub runners
    • Setup benchmarks, compare allocators
  • Release binaries for Windows ARM64/X64 and macOS X64 (to support all github-hosted runners)

crates.io

https://rust-lang.github.io/api-guidelines/checklist.html

Documentation

Crate is abundantly documented:

  • Crate level docs are thorough and include examples (C-CRATE-DOC)
  • All items have a rustdoc example (C-EXAMPLE)
  • Examples use ?, not try!, not unwrap (C-QUESTION-MARK)
  • Function docs include error, panic, and safety considerations (C-FAILURE)
  • Prose contains hyperlinks to relevant things (C-LINK)

Flexibility

Crate supports diverse real-world use cases:

  • Caller decides where to copy and place data (C-CALLER-CONTROL)
  • Functions minimize assumptions about parameters by using generics (C-GENERIC)

Stargazers over time

Starring the repository is helpful for releasing the project on upstream package managers.

Stargazers over time

License

The following licenses apply to this project:

About

For use with find-changes-action

Resources

License

Stars

Watchers

Forks

Contributors

Languages

Generated from anttiharju/rust-starter