From df64488a05cf5f9b65e7af4f927ec8428a23ed06 Mon Sep 17 00:00:00 2001
From: Meinte Boersma <meinte.boersma@gmail.com>
Date: Tue, 9 Jul 2024 13:19:36 +0200
Subject: [PATCH] trigger CI on PR

---
 .github/workflows/build.yaml |  8 +++-----
 CHANGELOG.md                 |  3 ++-
 README.md                    | 13 +++++++++++++
 3 files changed, 18 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index 3ef1e4bb..7fa8fd30 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -2,9 +2,8 @@ name: CI LionWeb-C#
 
 on:
   workflow_dispatch:
+  pull_request:
   push:
-    branches:
-      - '*'
     tags:
       - '*'
 
@@ -19,10 +18,9 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
-          fetch-depth: 0 # Get all history to allow automatic versioning using MinVer
-          # TODO  can we set this to 1 since we only need a tag?
+          fetch-depth: 1
 
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a5fb5673..45bed192 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,6 +18,7 @@ and this project adheres _loosely_ to [Semantic Versioning](https://semver.org/s
 
 
 ## [0.2.2] - unreleased
+
 ### Added
 
 - Generate interface for each factory; factory implementation methods are `virtual` now.
@@ -27,7 +28,7 @@ and this project adheres _loosely_ to [Semantic Versioning](https://semver.org/s
 - Released as open source under the Apache-2.0 license.
 - Set up CI using GitHub Actions.
 
-(Both are infrastructural—i.e.: non-code— changes.)
+(Both are infrastructural —i.e.: non-code— changes.)
 
 
 ## [0.2.1] - 2024-05-28
diff --git a/README.md b/README.md
index 1af7a385..a8c2c94b 100644
--- a/README.md
+++ b/README.md
@@ -10,12 +10,25 @@ This repository contains an implementation of (select parts of) the [LionWeb](ht
 .NET projects:
 
 * [`src/LionWeb-CSharp`]: implementation of LionWeb for/in C#
+* [`src/LionWeb-CSharp-Generator`]: implementation of a C# code generator for LionWeb
 * [`build/LionWeb-CSharp-build`]: a .NET console application that generates various source files in the `-Test` project
 * [`test/LionWeb-CSharp-Test`]: unit tests for `LionWeb-CSharp`
+* [`test/LionWeb-CSharp-Generator-Test`]: unit tests for `LionWeb-CSharp-Generator`
 
 See these projects' respective `README`s for more information.
 
 
+## CI
+
+The CI is implemented through a GitHub Action, configured through the file [`build.yaml` workflow YAML file](./.github/workflows/build.yaml).
+It's triggered:
+
+* On every event for a Pull Request, including opening one.
+* When a commit (on any branch) is tagged.
+    Provided that restoring, building, packaging, and running all tests are all successful,
+    then NuGet packages (for) `LionWeb-CSharp` and `LionWeb-CSharp-Generator` are published with the tag as version identification.
+
+
 ## License
 
 The "Apache-2.0" open-source license applies to the work in this repository.