Skip to content

Commit

Permalink
more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vinnie-fialok committed Jul 12, 2024
1 parent ff4abf1 commit d845a89
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion WTGPublishPackageGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,26 @@
This doc explains how the package we use at WTG is updated.

## Creating Releases with Github Actions
When a PR is merged to master, the GitHub Action 'Create release' should run. This action creates a GitHub Release and uploads the package to the release. The version number is also handled by the action. The package is created on build in the action and should contain Blazor.Diagrams.dll, Blazor.Diagrams.Core.dll and SvgPathProperties.dll. This action also pushes this release to NuGet, see: [WTG.Z.Blazor.Diagrams](https://proget.wtg.zone/feeds/Gallery/WTG.Z.Blazor.Diagrams/versions).

### Releases
When a PR is **merged to master**, the GitHub Action 'Create release' should run. This action creates a GitHub Release and uploads the package to the release.
The package is created on build in the action and should contain Blazor.Diagrams.dll, Blazor.Diagrams.Core.dll and SvgPathProperties.dll.

This action also pushes this release to NuGet, see [WTG.Z.Blazor.Diagrams on nuget](https://proget.wtg.zone/feeds/Gallery/WTG.Z.Blazor.Diagrams/versions). We access this internally at WiseTech through ProGet, see [WTG.Z.Blazor.Diagrams on proget](https://proget.wtg.zone/feeds/Gallery/WTG.Z.Blazor.Diagrams/versions). See [this article](https://inedo.com/proget/private-nuget-server) for more info about how and why proget is used as our source.

### Version Incrementing
The version number is also handled by the action using [@reecetech/version-increment](https://github.com/reecetech/version-increment). The semantic versioning scheme rules below are verbatim from [reecetech's README.md](https://github.com/reecetech/version-increment?tab=readme-ov-file#conventional-commits-semver-with-smarts-).

> the action will parse the last commit message (usually the merge commit) to determine the increment type for a semver version.
>
> The following increment types by keyword are supported:
> - patch: build, chore, ci, docs, fix, perf, refactor, revert, style, test
> - minor: feat
> - major: any of the above keywords followed by a '!' character, or 'BREAKING CHANGE:' in commit body
>
> If none of the keywords are detected, then the increment specified by the increment input will be used (defaults to patch).
For more info on semantic versioning, refer to the [semantic versioning spec](https://semver.org/spec/v2.0.0.html).

> [!tip]
> If you have a WTG workitem that requires a push to this repo, you will additionally need to update the WTG.Z.Blazor.Diagraqms version in the WTG Dev repo with the steps below.
Expand Down

0 comments on commit d845a89

Please sign in to comment.