For a long time, I've wanted a simple way always to know what code for a web app is in production. For code hosted in GitHub, Releases are the obvious way to do that. The issue for me however has always been how to automate this. There are various mature release automation solutions out there that do this I'm sure, but they all require substantial mental bandwidth to implement, not to mention cost (especially for private repositories). I've always needed a solution that complements my existing workflow rather than forcing me to implement a whole new tool or process. Therefore, this library is my attempt at a solution for creating Releases automatically during a web app publish or deployment in a very lightweight manner.
How to use:
-
Install Nuget package GitHub.AutoRelease.
-
In the startup code of your web app, create an AutoRelease object and call its
CreateOnStartupAsyncmethod. Note this is currently in beta.
The AutoRelease constructor requires a few arguments:
-
a GitHub API personal access token. To generate a token, go here. This token should be in your Web.config or settings file.
-
a UserAgent string that identifies your application to GitHub. I'm not entirely clear what this, but the info about this is here. See the related Octokit documentation here.
When calling CreateOnStartupAsync you pass
-
a
boolindicating whether your app is in production or not. This is determined in various ways. I didn't think it was right to make any assumptions here. -
optionally, a tag name. The typical use case I imagined was to leave the tag name null so that AutoRelease can generate a tag number for the current date.