CI

Author: Nigel Mukandi

.github/workflows/main.yaml

@@ -1,50 +1,66 @@
-name: Main Pipeline
+name: main
 
 on:
   push: 
     branches:
       - main
-
+  workflow_dispatch: 
+    
 jobs: 
   test:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
+      - name: checkout code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
 
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v3
+      - name: setup dotnet environment
+        uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d
         with:
           dotnet-version: '9.0'
 
-      - name: Restore dependencies
+      - run: dotnet --info    
+          
+      - name: restore dependencies
         run: dotnet restore
 
-      - name: Run test
-        run: dotnet test --no-restore --verbosity normal 
+      - name: build
+        run: dotnet build --configuration Release
+
+      - name: run test
+        run: dotnet test --configuration Release --no-restore --no-build --verbosity normal
 
-  publish:
+  publish-artifacts:
     runs-on: ubuntu-latest
+    name: publish artifacts
     needs: test
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-  
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v3
+      - name: checkout code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+        with:
+          fetch-depth: 1
+      
+      - name: setup dotnet environment
+        uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d
         with:
           dotnet-version: '9.0'
 
-      - name: Set up NuGet environment
-          env:
-            NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
-          run: |
-            echo "::add-mask::$NUGET_API_KEY"
-
-#      - name: Deploy to NuGet
-#        run: dotnet nuget push <package-name.nupkg> --api-key $NUGET_API_KEY --source https://api.nuget.org/v3/index.json
-#        
-#      - name: Cleanup built artifacts
-#          run: dotnet clean  
+      - run: dotnet --info
+      
+      - name: restore dependencies
+        run: dotnet restore
+        
+      - name: extract package version from csproj
+        run: |
+          BASE_VERSION=$(grep -oPm1 "(?<=<Version>)[^<]+" **/*.csproj)
+          echo "BASE_VERSION=$BASE_VERSION" >> $GITHUB_ENV
+          echo "Detected base version: $BASE_VERSION"
+     
+      - name: generate nuget package
+        run: dotnet pack --configuration Release --output artifacts 
 
-    
+      - name: upload artifact
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4
+        with: 
+          name: artifact
+          path: artifacts/
+          

.github/workflows/publish.yaml

@@ -0,0 +1,12 @@
+name: release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    name: release
+    steps:
+      - name: download artifacts
+        uses: actions/download-artifact@v6 

.github/workflows/pull-request.yaml

@@ -1,4 +1,4 @@
-name: Pull Request Pipeline
+name: pull request
 on:
   pull_request: 
     branches:
@@ -8,16 +8,21 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
+      - name: checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
 
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v3
+      - name: setup dotnet environment
+        uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d
         with:
           dotnet-version: '9.0'
-          
-      - name: Restore dependencies
+
+      - run: dotnet --info
+        
+      - name: restore dependencies
         run: dotnet restore
+
+      - name: build
+        run: dotnet build --configuration Release
 
-      - name: Run test
-        run: dotnet test --no-restore --verbosity normal 
+      - name: run test
+        run: dotnet test --configuration Release --no-restore --no-build --verbosity normal 

FiniteStateMachine/FiniteStateMachineBuilder.cs

@@ -1,17 +1,32 @@
 namespace FiniteStateMachine;
 
+/// <summary>
+/// Builder class for creating a finite state machine.
+/// </summary>
+/// <typeparam name="TState">Type representing the states of the machine.</typeparam>
+/// <typeparam name="TTrigger">Enum type representing triggers to cause transitions.</typeparam>
 public sealed class FiniteStateMachineBuilder<TState, TTrigger>
     where TTrigger : Enum
     where TState : notnull
 {
     private readonly TState _initialState;
     private readonly Dictionary<TState, Dictionary<TTrigger, TState>> _transitions = new();
-        
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="FiniteStateMachineBuilder{TState, TTrigger}"/> class.
+    /// </summary>
+    /// <param name="initialState">The initial state of the state machine.</param>
     internal FiniteStateMachineBuilder(TState initialState)
     {
         _initialState = initialState;
     }
-    
+        
+    /// <summary>
+    /// Defines a state and its possible transitions.
+    /// </summary>
+    /// <param name="state">The state to configure.</param>
+    /// <param name="configure">An action to configure the state transitions.</param>
+    /// <returns>A reference to the current builder instance.</returns>
     public FiniteStateMachineBuilder<TState, TTrigger> State(
         TState state,
         Action<StateConfiguration<TState, TTrigger>> configure)
@@ -21,7 +36,11 @@ public FiniteStateMachineBuilder<TState, TTrigger> State(
         _transitions.Add(state, cfg.Transitions);
         return this;
     }
-    
+        
+    /// <summary>
+    /// Builds and returns the configured state machine.
+    /// </summary>
+    /// <returns>A new state machine configured with specified states and transitions.</returns>
     public StateMachine<TState, TTrigger> Build()
     {
         var rules = GetTransitionRules();
@@ -30,41 +49,25 @@ public StateMachine<TState, TTrigger> Build()
 
     private Dictionary<RuleKey<TState, TTrigger>, Rule<TState, TTrigger>> GetTransitionRules()
     {
-        Dictionary<RuleKey<TState,TTrigger>,Rule<TState,TTrigger>> rules = [];
+        var rules = new Dictionary<RuleKey<TState, TTrigger>, Rule<TState, TTrigger>>();
         foreach (var (fromState, transitions) in _transitions)
         {
             foreach (var (trigger, targetState) in transitions)
             {
                 var ruleKey = new RuleKey<TState, TTrigger>
                 {
                     From = fromState,
-                    Trigger = trigger,
+                    Trigger = trigger
                 };
                 var rule = new Rule<TState, TTrigger>
                 {
                     From = fromState,
                     To = targetState,
-                    Trigger = trigger,
+                    Trigger = trigger
                 };
                 rules.Add(ruleKey, rule);
             }
         }
         return rules;
     }
-}
-
-public sealed class StateConfiguration<TState, TTrigger> where TTrigger : Enum
-{
-    private readonly TState _state;
-    internal Dictionary<TTrigger, TState> Transitions { get; } = new();
-
-    internal StateConfiguration(TState state)
-    {
-        _state = state;
-    }
-    
-    public TransitionConfiguration<TState, TTrigger> On(TTrigger trigger)
-    {
-        return new TransitionConfiguration<TState, TTrigger>(this, trigger);
-    }
 }

FiniteStateMachine/StateConfiguration.cs

@@ -0,0 +1,35 @@
+namespace FiniteStateMachine;
+
+/// <summary>
+/// Configuration class for defining transitions from a specific state.
+/// </summary>
+/// <typeparam name="TState">Type representing the states.</typeparam>
+/// <typeparam name="TTrigger">Enum type representing triggers.</typeparam>
+public sealed class StateConfiguration<TState, TTrigger> where TTrigger : Enum
+{
+    private readonly TState _state;
+        
+    /// <summary>
+    /// Gets the transitions defined for the current state.
+    /// </summary>
+    internal Dictionary<TTrigger, TState> Transitions { get; } = new();
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="StateConfiguration{TState, TTrigger}"/> class.
+    /// </summary>
+    /// <param name="state">The state to configure.</param>
+    internal StateConfiguration(TState state)
+    {
+        _state = state;
+    }
+        
+    /// <summary>
+    /// Starts the configuration of a transition for a given trigger.
+    /// </summary>
+    /// <param name="trigger">The trigger that causes a transition.</param>
+    /// <returns>A configuration object to setup the transition.</returns>
+    public TransitionConfiguration<TState, TTrigger> On(TTrigger trigger)
+    {
+        return new TransitionConfiguration<TState, TTrigger>(this, trigger);
+    }
+}