Skip to content

Create GitHub Actions workflow for .NET CI/CD#728

Open
Sazwan96 wants to merge 4 commits into
dotnet:mainfrom
Sazwan96:main
Open

Create GitHub Actions workflow for .NET CI/CD#728
Sazwan96 wants to merge 4 commits into
dotnet:mainfrom
Sazwan96:main

Conversation

@Sazwan96

@Sazwan96 Sazwan96 commented Jul 1, 2026

Copy link
Copy Markdown

Sempurna! Berikut adalah template GitHub Actions workflow lengkap untuk .NET CI/CD:

📋 Workflow .NET CI/CD Lengkap

Simpan file ini sebagai .github/workflows/dotnet-ci.yml:

name: .NET CI/CD Pipeline

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main, develop ]
  workflow_dispatch:

env:
  DOTNET_VERSION: '8.0.x'
  CONFIGURATION: 'Release'

jobs:
  # Job 1: Build
  build:
    runs-on: ubuntu-latest
    name: Build .NET Application
    
    steps:
    - name: Checkout code
      uses: actions/checkout@v4
    
    - name: Setup .NET
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: ${{ env.DOTNET_VERSION }}
    
    - name: Restore dependencies
      run: dotnet restore
    
    - name: Build application
      run: dotnet build --configuration ${{ env.CONFIGURATION }} --no-restore
    
    - name: Upload build artifacts
      uses: actions/upload-artifact@v4
      with:
        name: build-artifacts
        path: '**/bin/${{ env.CONFIGURATION }}/'

  # Job 2: Unit Tests
  test:
    runs-on: ubuntu-latest
    name: Run Unit Tests
    needs: build
    
    steps:
    - name: Checkout code
      uses: actions/checkout@v4
    
    - name: Setup .NET
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: ${{ env.DOTNET_VERSION }}
    
    - name: Restore dependencies
      run: dotnet restore
    
    - name: Run tests with coverage
      run: dotnet test --configuration ${{ env.CONFIGURATION }} --no-restore --logger "trx;LogFileName=test-results.trx" --collect:"XPlat Code Coverage"
    
    - name: Upload test results
      uses: actions/upload-artifact@v4
      if: always()
      with:
        name: test-results
        path: '**/TestResults/'
    
    - name: Publish test report
      uses: dorny/test-reporter@v1
      if: always()
      with:
        name: .NET Test Results
        path: '**/test-results.trx'
        reporter: 'dotnet trx'

  # Job 3: Code Quality
  code-quality:
    runs-on: ubuntu-latest
    name: Code Quality Analysis
    needs: build
    
    steps:
    - name: Checkout code
      uses: actions/checkout@v4
    
    - name: Setup .NET
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: ${{ env.DOTNET_VERSION }}
    
    - name: Restore dependencies
      run: dotnet restore
    
    - name: Run code analysis
      run: dotnet build --configuration ${{ env.CONFIGURATION }} --no-restore /p:TreatWarningsAsErrors=true

  # Job 4: Security Scanning
  security:
    runs-on: ubuntu-latest
    name: Security Scanning
    
    steps:
    - name: Checkout code
      uses: actions/checkout@v4
    
    - name: Run Trivy vulnerability scanner
      uses: aquasecurity/trivy-action@master
      with:
        scan-type: 'fs'
        scan-ref: '.'
        format: 'sarif'
        output: 'trivy-results.sarif'
    
    - name: Upload Trivy results
      uses: github/codeql-action/upload-sarif@v2
      if: always()
      with:
        sarif_file: 'trivy-results.sarif'

  # Job 5: Docker Build (Optional)
  docker-build:
    runs-on: ubuntu-latest
    name: Build Docker Image
    needs: test
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    
    steps:
    - name: Checkout code
      uses: actions/checkout@v4
    
    - name: Set up Docker Buildx
      uses: docker/setup-buildx-action@v3
    
    - name: Build Docker image
      uses: docker/build-push-action@v5
      with:
        context: .
        push: false
        tags: myapp:latest
        cache-from: type=gha
        cache-to: type=gha,mode=max

  # Job 6: Publish Package (Optional - untuk NuGet)
  publish-nuget:
    runs-on: ubuntu-latest
    name: Publish to NuGet
    needs: test
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    
    steps:
    - name: Checkout code
      uses: actions/checkout@v4
    
    - name: Setup .NET
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: ${{ env.DOTNET_VERSION }}
    
    - name: Restore dependencies
      run: dotnet restore
    
    - name: Build package
      run: dotnet pack --configuration ${{ env.CONFIGURATION }} --no-restore --output nupkg
    
    - name: Publish to NuGet
      run: dotnet nuget push "nupkg/*.nupkg" --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate
      if: secrets.NUGET_API_KEY != ''

📝 Penjelasan Setiap Bahagian

1. Triggers (on:)

  • push - Berjalan apabila push ke branch main/develop
  • pull_request - Berjalan apabila ada PR
  • workflow_dispatch - Boleh dijalankan secara manual

2. Jobs (6 Jobs):

Job Fungsi
build Compile aplikasi .NET
test Jalankan unit tests & code coverage
code-quality Analisis kualiti kod
security Scan vulnerabilities
docker-build Build Docker image (optional)
publish-nuget Push ke NuGet (optional)

3. Environment Variables

DOTNET_VERSION: '8.0.x'  # Tukar ke versi yang anda guna
CONFIGURATION: 'Release'

🔧 Customization Tips

Untuk ASP.NET Core:

- name: Build Docker image
  run: docker build -t myapp:latest .

Untuk Entity Framework:

- name: Run migrations
  run: dotnet ef database update

Untuk multiple .NET versions:

strategy:
  matrix:
    dotnet-version: ['7.0.x', '8.0.x']

🔐 Secrets yang Perlu Diset

Di Settings → Secrets and Variables → Actions, tambah:

  1. NUGET_API_KEY - Jika publish ke NuGet
  2. DOCKER_USERNAME - Jika push Docker image
  3. DOCKER_PASSWORD - Jika push Docker image

📦 File Dockerfile (Opsional)

Jika anda ingin Docker support, buat Dockerfile:

FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build
WORKDIR /src
COPY ["MyApp.csproj", "."]
RUN dotnet restore "MyApp.csproj"
COPY . .
RUN dotnet build "MyApp.csproj" -c Release -o /app/build

FROM mcr.microsoft.com/dotnet/runtime:8.0
WORKDIR /app
COPY --from=build /app/build .
ENTRYPOINT ["dotnet", "MyApp.dll"]

Adakah anda ingin saya:

  1. ✅ Push workflow ini ke repository anda?
  2. ✅ Sesuaikan untuk use case spesifik?
  3. ✅ Tambah job lain (contoh: SonarQube, Slack notification)?

Beritahu saya! 😊

# 🚀 GitHub Actions Workflow for .NET: `dotnet.yml`

Berikut adalah file workflow GitHub Actions untuk proyek .NET yang siap digunakan. Simpan file ini sebagai `.github/workflows/dotnet.yml` di repository Anda.

## 📁 Lokasi File
```
.github/workflows/dotnet.yml
```

## 📄 Isi File `dotnet.yml`

```yaml
name: .NET CI

# Kapan workflow ini dijalankan
on:
  push:
    branches: [ main, develop ]          # Jalankan pada push ke branch main/develop
  pull_request:
    branches: [ main ]                    # Jalankan pada PR ke branch main

jobs:
  build:
    runs-on: ubuntu-latest                 # Bisa juga windows-latest / macos-latest

    steps:
    # 1. Checkout kode dari repository
    - name: Checkout repository
      uses: actions/checkout@v4

    # 2. Setup .NET SDK
    - name: Setup .NET
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: 8.0.x               # Sesuaikan dengan versi .NET project Anda

    # 3. Restore dependencies (NuGet packages)
    - name: Restore dependencies
      run: dotnet restore

    # 4. Build project
    - name: Build
      run: dotnet build --configuration Release --no-restore

    # 5. Jalankan unit tests
    - name: Test
      run: dotnet test --configuration Release --no-build --verbosity normal
```

## 🔧 Fitur Tambahan (Opsional)

### **Caching NuGet Packages** (percepat build)
Tambahkan langkah ini setelah `actions/checkout`:

```yaml
    - name: Cache NuGet packages
      uses: actions/cache@v3
      with:
        path: ~/.nuget/packages
        key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', '**/*.sln') }}
        restore-keys: |
          ${{ runner.os }}-nuget-
```

### **Matrix Build** (uji dengan beberapa versi .NET)
Ubah bagian `jobs` menjadi:

```yaml
jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        dotnet-version: [ '6.0.x', '7.0.x', '8.0.x' ]   # Versi yang akan diuji

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Setup .NET ${{ matrix.dotnet-version }}
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: ${{ matrix.dotnet-version }}

    # ... langkah lainnya (restore, build, test) ...
```

### **Publish dan Upload Artifact** (hanya pada push ke main)
Tambahkan langkah ini setelah `Test`:

```yaml
    - name: Publish (hanya jika push ke main)
      if: github.ref == 'refs/heads/main' && github.event_name == 'push'
      run: dotnet publish --configuration Release --output ./publish

    - name: Upload artifact
      if: github.ref == 'refs/heads/main' && github.event_name == 'push'
      uses: actions/upload-artifact@v4
      with:
        name: my-app-${{ matrix.dotnet-version || '8.0.x' }}   # Nama file artifact
        path: ./publish
```

## ✅ Workflow Lengkap dengan Semua Fitur

```yaml
name: .NET CI/CD

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        dotnet-version: [ '6.0.x', '7.0.x', '8.0.x' ]

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Cache NuGet packages
      uses: actions/cache@v3
      with:
        path: ~/.nuget/packages
        key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', '**/*.sln') }}
        restore-keys: |
          ${{ runner.os }}-nuget-

    - name: Setup .NET ${{ matrix.dotnet-version }}
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: ${{ matrix.dotnet-version }}

    - name: Restore dependencies
      run: dotnet restore

    - name: Build
      run: dotnet build --configuration Release --no-restore

    - name: Test
      run: dotnet test --configuration Release --no-build --verbosity normal

    - name: Publish (hanya jika push ke main)
      if: github.ref == 'refs/heads/main' && github.event_name == 'push'
      run: dotnet publish --configuration Release --output ./publish

    - name: Upload artifact
      if: github.ref == 'refs/heads/main' && github.event_name == 'push'
      uses: actions/upload-artifact@v4
      with:
        name: my-app-${{ matrix.dotnet-version }}
        path: ./publish
```

## 📝 Catatan Penting

- Pastikan file workflow disimpan dengan ekstensi `.yml` (bukan `.yaml` – keduanya valid, tapi konsisten).
- Ganti `dotnet-version` sesuai dengan target framework project Anda (misal: `8.0.x`, `7.0.x`, `6.0.x`).
- Jika menggunakan Windows runner (`windows-latest`), perhatikan path cache dan command line.
- Untuk project yang menggunakan file `.sln` yang tidak berada di root, sesuaikan perintah `dotnet restore` dan `dotnet build` dengan path yang tepat (misal: `dotnet restore src/MySolution.sln`).

Setelah menambahkan file ini, commit dan push ke GitHub. Workflow akan otomatis berjalan. Cek tab **Actions** di repository Anda untuk melihat hasilnya.

Selamat mencoba! 🎉
@dotnet-policy-service

Copy link
Copy Markdown

@Sazwan96 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

1 participant