Skip to content

richtea/YAWN

Repository files navigation

Yet Another Workflow for Nuget

CI build status GitHub latest release

Contains a sample NuGet package, with a set of GitHub workflows that automate much of the development / release process.

See the developer documentation for information on how to follow the development / release lifecycle.

Main features

The interesting features of this repo are:

  • Provides release automation support. Complex manual release steps are easy to forget or get wrong. Having automated tooling avoids both these issues. Releasing a new version is as simple as 1 - 2 - 3: 1) manually running a workflow to create a release PR; 2) merge the PR; and 3) publish the automatically-created GitHub release (which is created in draft mode). The developer documentation describes this process in more detail.

  • Follows best practices from Microsoft and Meziantou as closely as possible. The build / deploy workflows contain package validation to ensure that the quality doesn't accidentally drop.

  • NuGet package properties are automatically configured. The package and repository URL properties use the repo URL by default.

  • If you have set up act to run GitHub workflows locally, there is a supporting script to help you. Be aware that not all workflows can run locally, because act doesn't currently support re-usable workflows.

  • Repository labels are managed declaratively by editing the config file.

License

The scripts and documentation in this project are released under the ISC License.

Credits

Package icon 'Under construction' created by max.icons - Flaticon

Pull Request and Tag icons by Icons8