Automate your package creation from GitHub to nuget!

by Steven Marahall | May 28, 2024 | GitHub | 0 comments

Introduction

In today’s fast-paced software development environment, automation is key to improving efficiency and reducing manual errors. GitHub and nuget are essential tools for .NET developers, and automating the workflow between these platforms can save significant time and effort. This article will guide you through setting up an automated workflow from GitHub to nuget using TomoPDF as an example.

Section 1: Prerequisites

Before we start, ensure you have the following tools and accounts:
– GitHub account
– NuGet.org account
– GitHub repository with TomoPDF (.NET project)
– GitHub Actions (for CI/CD automation)

Section 2: Setting Up Your GitHub Repository

First, you need to set up your GitHub repository for TomoPDF. Follow these steps:
1. Create a new repository on GitHub or use an existing one.
2. Clone the repository to your local machine.
3. Add your .NET project files to the repository.
4. Commit and push the changes to GitHub.

Best practices for structuring your repository for automation include organizing your project files logically, using a consistent naming convention, and ensuring your project can be built and tested using command-line tools.

Section 3: Creating aà NuGet Package

A NuGet package is a single ZIP file with a .nupkg extension that contains compiled code (DLLs), related files, and a descriptive manifest that includes information like the package’s version number. To create a NuGet package for TomoPDF:
1. Add a `.nuspec` file to your project or configure your project file for packing.
2. Use the following command to pack the project locally for testing:

dotnet pack --configuration Release

Section 4: Configuring GitHub Actions

GitHub Actions is a powerful automation platform that enables continuous integration and continuous delivery (CI/CD). To configure GitHub Actions for your repository:
1. Navigate to the `Actions` tab in your GitHub repository.
2. Create a new workflow and add a YAML file.

Section 5: Writing the Workflow File

Here is a sample `workflow.yml` file for automating the build and deployment of TomoPDF to NuGet:

name: CI/CD to NuGet

on:
push:
branches:
– main
pull_request:
branches:
– main

jobs:
build:
runs-on: windows-latest

steps:
– name: Checkout repository
uses: actions/checkout@v2

– name: Set up .NET
uses: actions/setup-dotnet@v1
with:
dotnet-version: ‘6.x’

– name: Restore dependencies
run: dotnet restore

– name: Build the project
run: dotnet build –configuration Release –no-restore

– name: Pack the project
run: dotnet pack –configuration Release –no-build –output ./nupkg

– name: Publish to NuGet

env:

NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
run: dotnet nuget push ./nupkg/*.nupkg –api-key $NUGET_API_KEY –source
https://api.nuget.org/v3/index.json

Section 6: Setting Up Secrets in GitHub

To securely store your NuGet API key in GitHub Secrets:
1. Navigate to your repository settings.
2. Go to the `Secrets` section.
3. Add a new secret named `NUGET_API_KEY` and paste your NuGet API key.

Section 7: Testing the Workflow

Push a change to the main branch to trigger the workflow. Monitor the Actions tab to see the workflow in action. Verify the package is published to NuGet.org.

Section 8: Troubleshooting Common Issues

Here are some common errors and how to resolve them:
– **Authentication failed**: Ensure your NuGet API key is correct and stored in GitHub Secrets.
– **Build errors**: Check your project configuration and dependencies.
– **Network issues**: Retry the workflow or check your network connection.

Tips for debugging workflow issues:
– Use the `steps` log in GitHub Actions to identify where the workflow failed.
– Make incremental changes and test frequently.

Conclusion

By automating the GitHub to NuGet process, you can streamline your development workflow, reduce manual errors, and ensure timely package releases. We hope this guide helps you set up your automated workflow. Explore further customizations and improvements to tailor the process to your needs.