updated the pipelines

Author: nitin27may

.github/workflows/template-publish.yml

@@ -74,10 +74,20 @@ jobs:
       - name: Copy README template
         shell: pwsh
         run: |
-          # Copy the README template if it exists
+          # Ensure README is properly set up for NuGet package
+          Write-Host "Setting up README for NuGet package..."
+          
+          # Check if README template exists in template-src
           if (Test-Path "./template-src/README.template.md") {
+            # Copy as main README.md in the template output root
             Copy-Item -Path "./template-src/README.template.md" -Destination "./template-output/README.md"
-          }
+            
+            # Create docs directory for NuGet's readme reference
+            New-Item -Path "./template-output/docs" -ItemType Directory -Force
+            Copy-Item -Path "./template-src/README.template.md" -Destination "./template-output/docs/README.md"
+            
+            Write-Host "✅ README files set up successfully"
+          } 
 
       - name: Copy and update .nuspec file
         shell: pwsh
@@ -184,6 +194,56 @@ jobs:
           # List files to verify creation
           dir
 
+      - name: Test template package without Angular
+        run: |
+          mkdir test-project-no-angular
+          cd test-project-no-angular
+          
+          # Create project from template without Angular
+          dotnet new cleanarch --organization TestCompany --projectName TestProjectNoAngular --includeAngular false
+          
+          # Verify that frontend directory is not created
+          if (Test-Path "./frontend") {
+            Write-Error "Frontend directory should not exist when includeAngular is false"
+            exit 1
+          }
+          
+          # List files to verify creation
+          dir
+
+      - name: Test template package with default folder naming
+        shell: pwsh
+        run: |
+          # Test with organization - should create folder YourCompany.TestProject
+          dotnet new cleanarch --organization YourCompany --projectName TestProject
+          
+          if (Test-Path "YourCompany.TestProject") {
+            Write-Host "✅ YourCompany.TestProject folder created successfully"
+          } else {
+            Write-Error "❌ YourCompany.TestProject folder not created"
+            exit 1
+          }
+          
+          # Test without organization - should create folder TestProjectNoOrg
+          dotnet new cleanarch --projectName TestProjectNoOrg
+          
+          if (Test-Path "TestProjectNoOrg") {
+            Write-Host "✅ TestProjectNoOrg folder created successfully"
+          } else {
+            Write-Error "❌ TestProjectNoOrg folder not created"
+            exit 1
+          }
+          
+          # Test with explicit output folder
+          dotnet new cleanarch --organization YourCompany --projectName TestProject -o CustomFolder
+          
+          if (Test-Path "CustomFolder") {
+            Write-Host "✅ CustomFolder created successfully"
+          } else {
+            Write-Error "❌ CustomFolder not created"
+            exit 1
+          }
+
       - name: Upload package artifact
         uses: actions/upload-artifact@v4
         with:

template-src/CleanArchitecture.FullStack.Template.nuspec

@@ -16,5 +16,13 @@
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <copyright>Copyright © Nitin Singh 2024</copyright>
     <summary>A full-stack template using Clean Architecture principles with .NET 9 API backend and Angular 19 frontend, containerized with Docker.</summary>
+    <readme>docs\README.md</readme>
   </metadata>
+  <files>
+    <!-- Include all template content files but exclude binaries and temp files -->
+    <file src="**\*" target="content" exclude="**\bin\**;**\obj\**;**\.git\**;**\.vs\**;**\.vscode\**;**\node_modules\**;**\.angular\**;**\docs\**" />
+    
+    <!-- Explicitly include the README for NuGet package display -->
+    <file src="docs\README.md" target="docs\" />
+  </files>
 </package>

template-src/README.template.md

@@ -21,13 +21,27 @@ This template provides a starting point for creating a Clean Architecture soluti
 2. **Create a new project using the template:**
 
    ```bash
+   # Create with organization - output folder will be "YourCompany.MyApp"
    dotnet new cleanarch --organization YourCompany --projectName MyApp
+
+   # Create without organization - output folder will be just "MyApp"
+   dotnet new cleanarch --projectName MyApp
+
+   # Create in a specific folder (overrides default folder behavior)
+   dotnet new cleanarch --organization YourCompany --projectName MyApp -o CustomFolder
    ```
 
 3. **Navigate to the project directory:**
 
    ```bash
+   # If created with organization
+   cd YourCompany.MyApp
+   
+   # If created without organization
    cd MyApp
+   
+   # If created with custom output folder
+   cd CustomFolder
    ```
 
 4. **Build and run the project:**
@@ -36,10 +50,64 @@ This template provides a starting point for creating a Clean Architecture soluti
    docker-compose up
    ```
 
+## Command Examples for Different Scenarios
+
+### Basic Usage
+
+```bash
+# Full-stack application with organization name
+dotnet new cleanarch --organization Acme --projectName ECommerce
+
+# Full-stack application without organization name
+dotnet new cleanarch --projectName ECommerce
+```
+
+### Backend-only Application
+
+```bash
+# Create backend-only application (exclude Angular)
+dotnet new cleanarch --organization Acme --projectName ApiService --includeAngular false
+
+# Backend-only application without organization name
+dotnet new cleanarch --projectName ApiService --includeAngular false
+```
+
+### Custom Output Location
+
+```bash
+# Specify a custom output folder
+dotnet new cleanarch --organization Acme --projectName ECommerce -o ./projects/ecommerce-app
+
+# Specify output folder without organization name
+dotnet new cleanarch --projectName ECommerce -o ./projects/ecommerce-app
+```
+
+### Combining Options
+
+```bash
+# Backend-only application with custom output folder
+dotnet new cleanarch --organization Acme --projectName ApiService --includeAngular false -o ./apis/service
+
+# Full options example
+dotnet new cleanarch --organization Acme --projectName ECommerce --includeAngular true -o ./projects/ecommerce-app
+```
+
 ## Template Parameters
 
 - `--organization`: Optional organization or company name to be used in namespaces. If specified, namespaces will be formatted as `YourCompany.MyApp.Feature`. If not specified, namespaces will be formatted as `MyApp.Feature`.
 - `--projectName`: The name of the project. Default is `MyApp`.
+- `--includeAngular`: Boolean flag to indicate whether to include the Angular frontend project. Default is `true`.
+- `-o|--output`: Optional parameter to specify a custom output folder. If not specified, the output folder will be `<organization>.<projectName>` if organization is provided, or just `<projectName>` if it isn't.
+
+## Output Folder Naming
+
+The template uses the following rules to determine the output folder name:
+
+| Command Parameters | Output Folder |
+| ------------------ | ------------- |
+| `--organization YourCompany --projectName MyApp` | `YourCompany.MyApp` |
+| `--projectName MyApp` (no organization) | `MyApp` |
+| `--organization YourCompany --projectName MyApp -o CustomFolder` | `CustomFolder` |
 
 ## Directory Structure
 

template-src/template.json

@@ -26,9 +26,34 @@
       "defaultValue": "MyApp",
       "replaces": "ProjectNamePlaceholder"
     },
+    "includeAngular": {
+      "type": "parameter",
+      "datatype": "bool",
+      "description": "If specified, includes the Angular frontend project.",
+      "defaultValue": "true"
+    },
     "skipOrgPrefix": {
       "type": "computed",
       "value": "(organization == \"\")"
+    },
+    "defaultFolderName": {
+      "type": "generated",
+      "generator": "coalesce",
+      "parameters": {
+        "sourceVariableName": "organization",
+        "fallbackVariableName": "projectName",
+        "operations": [
+          {
+            "type": "conditional",
+            "configuration": {
+              "condition": "(organization != \"\")",
+              "value": "$(organization).$(projectName)",
+              "else": "$(projectName)"
+            }
+          }
+        ]
+      },
+      "replaces": "defaultFolderName"
     }
   },
   "forms": {
@@ -39,5 +64,15 @@
         "to": "$1.$2"
       }
     }
-  }
+  },
+  "sources": [
+    {
+      "modifiers": [
+        {
+          "condition": "(!includeAngular)",
+          "exclude": [ "frontend/**/*" ]
+        }
+      ]
+    }
+  ]
 }