public-nuget-packages

Publicly available NuGet packages useful for building Keyfactor integrations

To access these packages add https://nuget.pkg.github.com/Keyfactor/index.json as a NuGet package source in Visual Studio or other development tools.

Some package availability changes from time to time. Please view the CHANGELOG.md for further details on changes to available libraries.

Adding a NuGet Package and/or Version

Via GitHub Actions

New versions of existing packages are registered automatically every Monday by the Upgrade NuGet Packages workflow, which opens a PR with any changes. Once merged, the daily Sync NuGet Packages workflow pushes the new versions to the GitHub Package Registry.

To add a brand new package or manually trigger a sync:

1. Add the package and version(s) to packages.yml.
2. Trigger the Sync NuGet Packages workflow.

Once complete, the package will be available in the Keyfactor Public GitHub Package Registry (GPR). The sync workflow runs automatically on a daily schedule and skips any versions already published.

Important

The package and version must already exist in the Azure DevOps feed before adding it to packages.yml: https://dev.azure.com/Keyfactor/Engineering/_artifacts/feed/KeyfactorPackages@Local

Running Locally

Prerequisites: Python 3.12+, dotnet CLI

1. Create a .env file in the repo root:

export AZ_DEVOPS_PAT=<Azure DevOps PAT with package read permissions>
export GITHUB_TOKEN=<GitHub PAT with write:packages permission>

2. Install dependencies:

python -m venv venv && source venv/bin/activate
pip install -e .

CLI Reference

scripts/sync_nuget.py is a CLI with five commands:

sync — Download and upload packages defined in a packages file. Skips versions already published to the GitHub Package Registry.

# Sync all packages
source .env && python scripts/sync_nuget.py sync packages.yml

# Sync a single package
source .env && python scripts/sync_nuget.py sync packages.yml --package Keyfactor.PKI

register — Add a package and version(s) to a packages file. Validates that each version exists in the Azure DevOps feed before writing.

# Register a new version of an existing package
source .env && python scripts/sync_nuget.py register packages.yml Keyfactor.PKI 8.4.0

# Register multiple versions at once
source .env && python scripts/sync_nuget.py register packages.yml Keyfactor.PKI 8.4.0 8.5.0

# Register a brand new package
source .env && python scripts/sync_nuget.py register packages.yml Keyfactor.NewPackage 1.0.0

# Skip Azure DevOps feed validation
python scripts/sync_nuget.py register packages.yml Keyfactor.PKI 8.4.0 --skip-validate

After registering, run sync to push the new version(s) to the GitHub Package Registry.

upgrade — Query Azure DevOps for new versions of all packages already listed in a packages file and register them automatically.

# Check all packages for new stable versions and register them
source .env && python scripts/sync_nuget.py upgrade packages.yml

# Preview what would be registered without writing
source .env && python scripts/sync_nuget.py upgrade packages.yml --dry-run

# Upgrade a single package
source .env && python scripts/sync_nuget.py upgrade packages.yml --package Keyfactor.PKI

# Include prerelease versions
source .env && python scripts/sync_nuget.py upgrade packages.yml --include-prerelease

After upgrading, run sync to push the new versions to the GitHub Package Registry.

sort — Sort versions for all packages in a packages file into ascending semver order and remove any duplicates.

python scripts/sync_nuget.py sort packages.yml

download — Download a single package version from Azure DevOps without uploading it.

# Download to the default nupkgs/ directory
source .env && python scripts/sync_nuget.py download Keyfactor.PKI 8.4.0

# Download to a custom directory
source .env && python scripts/sync_nuget.py download Keyfactor.PKI 8.4.0 --output-dir /tmp/packages

Manually using dotnet CLI

1. Create a GitHub PAT with write:packages access and grant it SSO.
2. Push the package:

dotnet nuget push ./Your.Package.1.0.0.nupkg \
  --source "https://nuget.pkg.github.com/keyfactor/index.json" \
  --api-key $GITHUB_TOKEN