Skip to content

update-nuget-packages.md

Latest commit

 

History

History
96 lines (66 loc) · 3.11 KB

update-nuget-packages.md

File metadata and controls

96 lines (66 loc) · 3.11 KB

Update nuget packages

Each project of the framework directory is build and provided as an nuget package.

To be able to build and test changes locally we recommend the following setup:

Local nuget directory

  1. Create a directory to store the locally build nuget packages
mkdir ~/packages
  1. Add the directory to the nuget config
dotnet nuget add source ~/packages --name local

Update version for packages

After the changes within the source code are done you can execute the following script from the root of the project to update the packages:

To update the version for the packages:

./scripts/update_framework_versions.sh <version>

For version there are the following options:

  • major
  • minor
  • patch
  • alpha
  • beta
  • rc
  • pre

Depending on the version the Directory.Build.props of the project will be updated. For major, minor and patch the version will be incremented by 1. For alpha, beta, rc, pre the Suffix will be set, if the version is already in the suffix it will be incremented by one.

Example:

current value used version new value
1.0.0 major 2.0.0
1.1.0 major 2.0.0
1.1.0.alpha major 2.0.0
1.0.0 minor 1.1.0
1.1.0 minor 1.2.0
1.0.1 minor 1.1.0
1.1.0.alpha minor 1.2.0
1.0.0 patch 1.0.1
1.1.0 patch 1.1.1
1.0.1 minor 1.0.2
1.1.0.alpha minor 1.1.1
1.1.0 alpha 1.1.0.alpha
1.1.0.alpha.1 alpha 1.1.0.alpha.2
1.1.0.beta alpha 1.1.0.alpha

Build and push nuget packages

To build and push the changed nuget packages make sure to first update the package version, you should use one of the script mentioned above to make sure that all dependent packages are updated as well.

After all packages are updated to the wanted version you can run the following command from the root of the project to build and push the nuget packages:

To push the updated packages to the local source

./scripts/pack_and_push_packages_local.sh

To update the version of a specific package:

./scripts/pack_and_push_packages.sh <NUGET_API_KEY>

NUGET_API_KEY is the key generated on nuget.org. The last command should only be executed within the github action nuget-package-push

Github Action

The github action to publish the newly created github packages will automatically be executed with every push on the main branch and or a rc candidate branch. It is to be expected that the action might fail due to duplicate versions if for example a package was updated within a release and will than be merged to main.

NOTICE

This work is licensed under the Apache-2.0.
⚡