Skip to content

docs: add section on build asset attestation to README #206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 7, 2025
Merged

docs: add section on build asset attestation to README #206

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20ff2e5
docs: add section on build asset attestation to README
DennisDyallo Mar 7, 2025
5b046c8
Update README.md
DennisDyallo Mar 7, 2025
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Enterprise-grade cross-platform SDK for YubiKey integration, built on .NET.
- [Yubico.Core](#yubicocore)
- [Internal Assemblies](#internal-assemblies)
- [Yubico.NativeShims](#yubiconativeshims)
- [Build asset attestation](#build-asset-attestation)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [Building the Project](#building-the-project)
Expand Down Expand Up @@ -98,6 +99,12 @@ Platform abstraction layer (PAL) providing:
> 🔧 **Unmanaged Library**
> Provides stable ABI for P/Invoke operations in Yubico.Core.

## Build asset attestation
Using [GitHub Attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds), you are able to verify that the NuGet package has been generated from our repository, right down to the specific GitHub Action that built it like this:
`> gh attestation verify .\Yubico.Core.1.12.0.nupkg --repo Yubico/Yubico.NET.SDK`

Note that you need to have the [`gh`](https://cli.github.com/) CLI installed.

## Project Structure

Repository organization:
Expand Down