try-github-actions-in-csharp

⚠️ This repository is intended for me.

An example of creating and executing custom GitHub Actions in C#.

C#でカスタムな GitHub Actions の作成と実行例です。

以下、個人的な注意点。

• Dockerfile ファイル名: F ---> f
  • ❌ DockerFile
  • 🆗 Dockerfile
• ENTRYPOINT
  • ❌

     # Relayer the .NET SDK, anew with the build output
    FROM mcr.microsoft.com/dotnet/sdk:6.0
    WORKDIR /app                                        # (A) 
    COPY --from=build-env /app/out .
    ENTRYPOINT [ "dotnet", "GithubActions.Csharp.dll" ] # ❌ (A) と不一致: `/` が必要

  • 🆗

     # Relayer the .NET SDK, anew with the build output
    FROM mcr.microsoft.com/dotnet/sdk:6.0
    WORKDIR /app                                        # (A) 
    COPY --from=build-env /app/out .
    ENTRYPOINT [ "dotnet", "/app/GithubActions.Csharp.dll" ]

src/Dockerfile

# Set the base image as the .NET 6.0 SDK (this includes the runtime)
FROM mcr.microsoft.com/dotnet/sdk:6.0 as build-env

# Copy everything and publish the release (publish implicitly restores and builds)
WORKDIR /src
COPY . ./
RUN dotnet publish ./GithubActions.Csharp/GithubActions.Csharp.csproj -c Release -o out --no-self-contained

# Set the final image as the .NET 6.0 runtime, anew with the build output.
FROM mcr.microsoft.com/dotnet/runtime:6.0 as final
WORKDIR /app
COPY --from=build-env /src/out .
ENTRYPOINT [ "dotnet", "/app/GithubActions.Csharp.dll" ]

src/action.yml

プライベートアクションとパブリックアクションとではruns.images の設定が異なります。

• プライベートアクション

  runs:
    using: 'docker'
    image: 'Dockerfile'

  プライベートアクションの場合:

  name: 'try-github-actions-in-csharp'
  description: 'An example of creating and executing custom GitHub Actions in C#.'
  branding:
    icon: sliders
    color: purple
  inputs:
    firstName:
      description: 'First Name.'
      required: true
    lastName:
      description: 'Last Name.'
      required: true
  outputs:
    summary-details:
      description: 'A detailed summary of all the projects that were flagged.'
  runs:
    using: 'docker'
    image: 'Dockerfile'
    args:
      - '--first-name'
      - ${{ inputs.firstName }}
      - '--last-name'
      - ${{ inputs.lastName }}

• パブリックアクション

  注意点としては、ここで指定されたDockerイメージは Public にする必要があります。

  runs:
    using: 'docker'
    image: 'docker://ghcr.io/maremare/try-github-actions-in-csharp'

  パブリックアクションの場合:

  name: 'try-github-actions-in-csharp'
  description: 'An example of creating and executing custom GitHub Actions in C#.'
  branding:
    icon: sliders
    color: purple
  inputs:
    firstName:
      description: 'First Name.'
      required: true
    lastName:
      description: 'Last Name.'
      required: true
  outputs:
    summary-details:
      description: 'A detailed summary of all the projects that were flagged.'
  runs:
    using: 'docker'
    image: 'docker://ghcr.io/maremare/try-github-actions-in-csharp'
    args:
      - '--first-name'
      - ${{ inputs.firstName }}
      - '--last-name'
      - ${{ inputs.lastName }}

.github/workflows/main.yml

プライベートアクションとして、Docker ビルドとアクションの実行を行います。

プライベートアクションの場合:

# The name of the work flow. Badges will use this name
name: 'An example of creating and executing custom GitHub Actions in C#.'

on:
  push:
    branches: [ main ]
  workflow_dispatch:
    inputs:
      reason:
        description: 'The reason for running the workflow'
        required: true
        default: 'Manual run'

jobs:
  try-github-actions-in-csharp:

    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write

    steps:
    - uses: actions/checkout@v3

    - name: 'Print manual run reason'
      if: ${{ github.event_name == 'workflow_dispatch' }}
      run: |
        echo 'Reason: ${{ github.event.inputs.reason }}'

    - name: GithubActions.Csharp
      id: github-actions-csharp
      uses: ./src # Uses an action in this directory
      env:
        # Pass the environment variables to the C# module on the Docker container.
        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 
      with:
        firstName: ${{ github.repository_owner }}
        lastName: ${{ github.repository }}
      
    # Use the output from the `hello` step
    - name: Get the output
      run: echo "The output was ${{ steps.github-actions-csharp.outputs.summary-details }}"

.github/workflows/build.yml

注意点としては、Dockerfile がルート以外のサブフォルダにある場合は、build-push-action に context: "{{defaultContext}}:src" # path to Dockerfile を指定します。

• docker/build-push-action: GitHub Action to build and push Docker images with Buildx

# The name of the work flow. Badges will use this name
name: 'Build Docker Image.'

on:
  push:
    branches: [ main ]
    paths:
      - "src/**"
  workflow_dispatch:
    inputs:
      reason:
        description: 'The reason for running the workflow'
        required: true
        default: 'Manual run'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: 🛒 Checkout
        uses: actions/checkout@v3

      - name: 🖨️ Print manual run reason
        if: ${{ github.event_name == 'workflow_dispatch' }}
        run: |
          echo 'Reason: ${{ github.event.inputs.reason }}'

      - name: ✨ Set up .NET 6.0
        uses: actions/setup-dotnet@v2
        with:
          dotnet-version: 6.0.x

      - name: 🚚 Restore dependencies
        working-directory: src
        run: dotnet restore

      - name: 🛠️ Build
        working-directory: src
        run: dotnet build --configuration Release --no-restore

  docker:
    runs-on: ubuntu-latest
    needs: [ build ]
    steps:
      - name: ✨ Set up QEMU
        uses: docker/setup-qemu-action@v2
      
      - name: ✨ Set up Docker Buildx
        uses: docker/setup-buildx-action@v2
      
      - name: 🚪 Login to GitHub Container Registry
        uses: docker/login-action@v1
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}
      
      - name: 📦 Build and push
        uses: docker/build-push-action@v3
        with:
          context: "{{defaultContext}}:src" # path to Dockerfile
          push: true
          tags: ghcr.io/maremare/try-github-actions-in-csharp:latest

.github/workflows/run.yml

# The name of the work flow. Badges will use this name
name: 'Run Docker Container Action.'

on:
  # schedule:
  #   - cron: '45 6 * * 6'
  workflow_dispatch:
    inputs:
      reason:
        description: 'The reason for running the workflow'
        required: true
        default: 'Manual run'

jobs:

  try-github-actions-in-csharp:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write

    steps:
      - name: 🛒 Checkout
        uses: actions/checkout@v3

      - name: 🖨️ Print manual run reason
        if: ${{ github.event_name == 'workflow_dispatch' }}
        run: |
          echo 'Reason: ${{ github.event.inputs.reason }}'

      - name: 🏥 try-github-actions-in-csharp
        id: try-github-actions-in-csharp
        # uses: maremare/try-github-actions-in-csharp@main
        uses: ./src # Uses an action in this directory
        with:
          firstName: ${{ github.repository_owner }}
          lastName: ${{ github.repository }}
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      # Use the output from the `hello` step
      - name: 📤 Get the output
        run: echo "The output was ${{ steps.try-github-actions-in-csharp.outputs.summary-details }}"

Actions の実行結果

Actions を実行した結果を以下に追記してみます。

• updated! 2022/08/13 09:48:24(UTC)

• updated! 2022/08/13 09:58:48(UTC)

• updated! 2022/08/16 19:53:40(UTC)