[Enter useful description for Morphir]
GitHub Actions |
---|
Package | Stable | Prerelease |
---|---|---|
Morphir |
Make sure the following requirements are installed on your system:
or
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
GITHUB_TOKEN
will be used to upload release notes and NuGet packages to GitHub.
DISABLE_COVERAGE
Will disable running code coverage metrics. AltCover can have severe performance degradation so it's worth disabling when looking to do a quicker feedback loop.
DISABLE_COVERAGE=1 ./build.sh
> build.cmd <optional buildtarget> // on windows
$ ./build.sh <optional buildtarget>// on unix
Clean
- Cleans artifact and temp directories.DotnetRestore
- Runs dotnet restore on the solution file.DotnetBuild
- Runs dotnet build on the solution file.DotnetTest
- Runs dotnet test on the solution file.GenerateCoverageReport
- Code coverage is run during DotnetTest
and this generates a report via ReportGenerator.WatchApp
- Runs dotnet watch on the application. Useful for rapid feedback loops.WatchTests
- Runs dotnet watch with the test projects. Useful for rapid feedback loops.GenerateAssemblyInfo
- Generates AssemblyInfo for libraries.CreatePackages
- Runs the packaging task from dotnet-packaging. This creates applications for win-x64
, osx-x64
and linux-x64
- Runtime Identifiers.
win-x64
application in a .zip file.osx-x64
application in a .tar.gz file.linux-x64
application in a .tar.gz file.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.FormatCode
- Runs Fantomas on the solution file.Release
- Task that runs all release type tasks such as GitRelease
and GitHubRelease
. Make sure to read Releasing to setup your environment correctly for releases.git add .
git commit -m "Scaffold"
git remote add origin https://github.com/user/MyCoolNewApp.git
git push -u origin master
GITHUB_TOKEN
to upload release notes and artifacts to githubThen update the CHANGELOG.md
with an "Unreleased" section containing release notes for this version, in KeepAChangelog format.
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/user/MyCoolNewApp.git/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/user/MyCoolNewApp.git/releases/tag/v0.1.0
Release
target, specifying the version number either in the RELEASE_VERSION
environment
variable, or else as a parameter after the target name. This will:
CHANGELOG.md
, moving changes from the Unreleased
section into a new 0.2.0
sectionBump version to 0.2.0
and adds the new changelog section to the commit's bodymacOS/Linux Parameter:
./build.sh Release 0.2.0
macOS/Linux Environment Variable:
RELEASE_VERSION=0.2.0 ./build.sh Release