Skip to content

Latest commit

 

History

History
161 lines (111 loc) · 8.62 KB

README.md

File metadata and controls

161 lines (111 loc) · 8.62 KB
Raw

MyLib.1

[Enter useful description for MyLib.1]

Builds

GitHub Actions
GitHub Actions
Build History

NuGet

Package Stable Prerelease
MyLib.1 NuGet Badge NuGet Badge

Developing

Make sure the following requirements are installed on your system:

or

Environment Variables

  • CONFIGURATION will set the configuration of the dotnet commands. If not set, it will default to Release.
    • CONFIGURATION=Debug ./build.sh will result in -c additions to commands such as in dotnet build -c Debug
  • ENABLE_COVERAGE Will enable running code coverage metrics. AltCover can have severe performance degradation so code coverage evaluation are disabled by default to speed up the feedback loop.
    • ENABLE_COVERAGE=1 ./build.sh will enable code coverage evaluation

Building

> build.cmd <optional buildtarget> // on windows
$ ./build.sh  <optional buildtarget>// on unix

The bin of your library should look similar to:

$ tree src/MyLib.1/bin/
src/MyLib.1/bin/
└── Debug
    └── net8.0
        ├── MyLib.1.deps.json
        ├── MyLib.1.dll
        ├── MyLib.1.pdb
        └── MyLib.1.xml

Build Targets

  • Clean - Cleans artifact and temp directories.
  • DotnetRestore - Runs dotnet restore on the solution file.
  • DotnetBuild - Runs dotnet build on the solution file.
  • FSharpAnalyzers - Runs BinaryDefense.FSharp.Analyzers.
  • DotnetTest - Runs dotnet test on the solution file.
  • GenerateCoverageReport - Code coverage is run during DotnetTest and this generates a report via ReportGenerator.
  • ShowCoverageReport - Shows the report generated in GenerateCoverageReport.
  • WatchTests - Runs dotnet watch with the test projects. Useful for rapid feedback loops.
  • GenerateAssemblyInfo - Generates AssemblyInfo for libraries.
  • DotnetPack - Runs dotnet pack. This includes running Source Link.
  • SourceLinkTest - Runs a Source Link test tool to verify Source Links were properly generated.
  • PublishToNuGet - Publishes the NuGet packages generated in DotnetPack to NuGet via paket push. Runs only from Github Actions.
  • GitRelease - Creates a commit message with the Release Notes and a git tag via the version in the Release Notes.
  • GitHubRelease - Publishes a GitHub Release with the Release Notes and any NuGet packages. Runs only from Github Actions.
  • FormatCode - Runs Fantomas on the solution file.
  • CheckFormatCode - Runs Fantomas --check on the solution file.
  • BuildDocs - Generates Documentation from docsSrc and the XML Documentation Comments from your libraries in src.
  • WatchDocs - Generates documentation and starts a webserver locally. It will rebuild and hot reload if it detects any changes made to docsSrc files, or libraries in src.

Releasing

git init
git add .
git commit -m "Scaffold"
git branch -M MyReleaseBranch
git remote add origin https://github.com/MyGithubUsername/MyLib.1.git
git push -u origin MyReleaseBranch

NOTE: Its highly recommend to add a link to the Pull Request next to the release note that it affects. The reason for this is when the RELEASE target is run, it will add these new notes into the body of git commit. GitHub will notice the links and will update the Pull Request with what commit referenced it saying "added a commit that referenced this pull request". Since the build script automates the commit message, it will say "Bump Version to x.y.z". The benefit of this is when users goto a Pull Request, it will be clear when and which version those code changes released. Also when reading the CHANGELOG, if someone is curious about how or why those changes were made, they can easily discover the work and discussions.

Here's an example of adding an "Unreleased" section to a CHANGELOG.md with a 0.1.0 section already released.

## [Unreleased]

### Added
- Does cool stuff!

### Fixed
- Fixes that silly oversight

## [0.1.0] - 2017-03-17
First release

### Added
- This release already has lots of features

[Unreleased]: https://github.com/MyGithubUsername/MyLib.1/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/MyGithubUsername/MyLib.1/releases/tag/v0.1.0
  • You can then use the GitRelease target, specifying the version number either in the RELEASE_VERSION environment variable, or else as a parameter after the target name. This will:
    • update CHANGELOG.md, moving changes from the Unreleased section into a new 0.2.0 section
      • if there were any prerelease versions of 0.2.0 in the changelog, it will also collect their changes into the final 0.2.0 entry
    • make a commit bumping the version: Bump version to 0.2.0 and adds the new changelog section to the commit's body
    • push a git tag

macOS/Linux Parameter:

./build.sh Release 0.2.0

macOS/Linux Environment Variable:

RELEASE_VERSION=0.2.0 ./build.sh Release
  • The Github Action will handle the new tag:
    • publish the package to NuGet
    • create a GitHub release for that git tag, upload release notes and NuGet packages to GitHub

Releasing Documentation