Add vendored-openssl feature (#16)

* Add vendored-openssl feature

* Fix megalinter whining

* Update codeowners

* Revert "Update codeowners"

This reverts commit 9e9a9e7.

* Update codeowners again

Author: petekubiak

.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/
+.github/workflows/

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).

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.
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "commitment-issues"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 authors = ["Pete Kubiak <peter.kubiak@dyson.com>"]
 
@@ -14,3 +14,7 @@ syn = "2.0"
 
 [lib]
 proc-macro = true
+
+[features]
+default = []
+vendored-openssl = ["git2/vendored-openssl"]

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
 
@@ -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.