From 95734f29cdcef0d5eb1e289de938c5bd8cb6e0f4 Mon Sep 17 00:00:00 2001 From: Pete Kubiak Date: Fri, 5 Sep 2025 13:39:18 +0100 Subject: [PATCH 1/5] Add vendored-openssl feature --- Cargo.toml | 6 +++++- README.md | 7 +++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 0c20cce..de8f9c3 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "commitment-issues" -version = "0.1.0" +version = "0.1.1" edition = "2021" authors = ["Pete Kubiak "] @@ -14,3 +14,7 @@ syn = "2.0" [lib] proc-macro = true + +[features] +default = [] +vendored-openssl = ["git2/vendored-openssl"] diff --git a/README.md b/README.md index 0fd75d1..e9f03b7 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,13 @@ The template's [main.rs](https://github.com/dysonltd/commitment-issues/blob/main Compile and run your project using your standard process. +## Troubleshooting + +This crate relies on git2, which in turn relies on openssl-sys. +By default, openssl-sys has libssl-dev as a dependency. +This can sometimes cause issues when building in dev containers or cross-compiling. +If you see issues relating to being unable to find openssl headers, try activating the `openssl-vendored` feature. + ## Inspecting binary metadata The metadata can be found in a section called ".metadata" within the executable binary generated by cargo. From 3e8309e28243b14a5c52fe1b652525c39217e0a1 Mon Sep 17 00:00:00 2001 From: Pete Kubiak Date: Fri, 5 Sep 2025 13:54:23 +0100 Subject: [PATCH 2/5] Fix megalinter whining --- CODE_OF_CONDUCT.md | 4 ++-- CONTRIBUTING.md | 2 +- README.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 8437abd..6f68b21 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -115,11 +115,11 @@ the community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available [here](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html). +[version 2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html). Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org -For answers to common questions about this code of conduct, see the [FAQ](https://www.contributor-covenant.org/faq). Translations are available [here](https://www.contributor-covenant.org/translations). +For answers to common questions about this code of conduct, see the [FAQ](https://www.contributor-covenant.org/faq). [Translations are available here](https://www.contributor-covenant.org/translations). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b6aa80..8ac67a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ Thank you for considering contributing to the Commitment issues project! We welc ## Code Style -- Follow the existing code style. This can be done by running `mega-linter-runner --fix` before your commit. This check will also run in the CI when doing a merge and point out any fixes that are required. More information on MegaLinter can be found [here](https://megalinter.io/latest/) +- Follow the existing code style. This can be done by running `mega-linter-runner --fix` before your commit. This check will also run in the CI when doing a merge and point out any fixes that are required. [More information on MegaLinter can be found here](https://megalinter.io/latest/) - Write clear and concise commit messages. - Include comments where necessary. diff --git a/README.md b/README.md index e9f03b7..028eb4e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Embed git repository metadata into compiled binaries. ### Creating a new project from template A very simple `cargo generate` example template is provided which demonstrates usage of the crate in a natively-compiled binary. -To use the template, you will need cargo generate installed (for instructions see [here](https://github.com/cargo-generate/cargo-generate/tree/main)). +To use the template, you will need cargo generate installed (for instructions see [the cargo-generate docs](https://github.com/cargo-generate/cargo-generate/tree/main)). #### Generate the project From 9e9a9e70fed5d528ad8b491bb7d3f7e8a85f6d41 Mon Sep 17 00:00:00 2001 From: Pete Kubiak Date: Fri, 5 Sep 2025 13:59:26 +0100 Subject: [PATCH 3/5] Update codeowners --- .github/CODEOWNERS | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index f8b8494..35cbf81 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,8 +1,8 @@ # Default owners for all files -* @petekubiak @ScottGibb @jamessizeland +* @petekubiak # Override the default owners and remove ownership for specific files Cargo.toml # Override the default owners and remove ownership for the .github/workflows directory -.github/workflows/ \ No newline at end of file +.github/workflows/ From 916357cda8f82e68a8f1f9654c2ee6784fcc9d54 Mon Sep 17 00:00:00 2001 From: Pete Kubiak Date: Fri, 5 Sep 2025 14:03:09 +0100 Subject: [PATCH 4/5] Revert "Update codeowners" This reverts commit 9e9a9e70fed5d528ad8b491bb7d3f7e8a85f6d41. --- .github/CODEOWNERS | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 35cbf81..f8b8494 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,8 +1,8 @@ # Default owners for all files -* @petekubiak +* @petekubiak @ScottGibb @jamessizeland # Override the default owners and remove ownership for specific files Cargo.toml # Override the default owners and remove ownership for the .github/workflows directory -.github/workflows/ +.github/workflows/ \ No newline at end of file From 897c905a31fa0d7834014d32cda9d33cc4cff042 Mon Sep 17 00:00:00 2001 From: Pete Kubiak Date: Fri, 5 Sep 2025 14:03:49 +0100 Subject: [PATCH 5/5] Update codeowners again --- .github/CODEOWNERS | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index f8b8494..9d6a21d 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,8 +1,8 @@ # Default owners for all files -* @petekubiak @ScottGibb @jamessizeland +* @petekubiak @ScottGibb @jamessizeland @mrossington # Override the default owners and remove ownership for specific files Cargo.toml # Override the default owners and remove ownership for the .github/workflows directory -.github/workflows/ \ No newline at end of file +.github/workflows/