Skip to main content

Github–Create a new release–The automated version

Yesterday I showed you how to create a new release in Github manually. This was a good starting point as it introduced the different elements of a release and the options we have. Today let us automate the process of creating a release on GitHub using GitHub Actions.

Create a new release using Github Actions

  • Go to Actions inside Github and click on new workflow.

  • We’ll not use an existing template but instead choose to setup the workflow ourself:

  • Paste the following yaml content in the editor screen. I’ll explain it afterwards…


Explanation of the Workflow

  • name: This is the name of your workflow. You can name it something like "Release".

  • on: Specifies the event that will trigger the workflow. In this case, it’s triggered by a push to a tag that matches the pattern v*.*.* (e.g., v1.0.0).

  • jobs: This defines the job that will be run by the workflow.

  • runs-on: Specifies the environment where the job will run. In this case, it uses the latest Windows environment.

  • steps: This section lists the steps the job will take. I’ll focus on the actions specific for the release

    • actions/checkout@v4: Checks out the repository's code so that the workflow can access it.

    • actions/create-release@v1: This action is used to create the release. It uses the GITHUB_TOKEN secret to authenticate with GitHub. The release is named after the tag and includes a basic description. The draft and prerelease options can be set to true if you want the release to be a draft or a pre-release.

    • actions/upload-release-asset@v1: This action uploads assets (like compiled binaries, zipped files, etc.) to the release. The upload_url is provided by the previous step where the release was created.

Trigger the workflow

The workflow is set to trigger on a tag push that matches the pattern v*.*.*. Create a new tag and push it to trigger the workflow.

I can do this through the commandline:

git tag v1.0.0
git push origin v1.0.0

Or if you prefer a GUI, you can use for example Github Desktop:

  • Go to the History tab to see the latest commits: 

  • Right click on a commit and choose Create tag:
  • Specify a tag name using the v*.*.* pattern
  • Now we have one change that we should push to our remote origin:

The Github Actions workflow should pick up this change and start the release pipeline:

Once completed we have a brand new release available:


Nice!

Remark: We can further improve this by automatically generating the release notes but that is something I’ll leave for another post.




Labels:

Popular posts from this blog

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

.NET 8–Keyed/Named Services

A feature that a lot of IoC container libraries support but that was missing in the default DI container provided by Microsoft is the support for Keyed or Named Services. This feature allows you to register the same type multiple times using different names, allowing you to resolve a specific instance based on the circumstances. Although there is some controversy if supporting this feature is a good idea or not, it certainly can be handy. To support this feature a new interface IKeyedServiceProvider got introduced in .NET 8 providing 2 new methods on our ServiceProvider instance: object? GetKeyedService(Type serviceType, object? serviceKey); object GetRequiredKeyedService(Type serviceType, object? serviceKey); To use it, we need to register our service using one of the new extension methods: Resolving the service can be done either through the FromKeyedServices attribute: or by injecting the IKeyedServiceProvider interface and calling the GetRequiredKeyedServic...
Read more

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...
Read more