@cbs-consulting/generator-btp 1.2.10 → 1.3.0

package/generators/setup-azure-devops/templates/scripts/setup-azure-devops/README.md

@@ -0,0 +1,158 @@
+# Azure DevOps Setup Script
+
+This directory contains a script to automate the configuration of your Azure DevOps repository with branch policies and CI/CD pipeline.
+
+## What This Script Does
+
+The `setup.sh` script configures the following in your Azure DevOps repository:
+
+### Branch Configuration
+
+- **Creates** the `development` branch if it doesn't exist
+- **Optionally sets** `development` as the default branch (configurable)
+
+### `Main` Branch Policies
+
+- **Minimum reviewers**: Requires at least 1 approver (configurable)
+- **Prohibits self-approval**: The person who created the PR cannot approve it
+- **Reset approvals on push**: Optionally reset votes when new commits are pushed (configurable)
+- **Build validation**: Automatically runs the pipeline to validate PRs
+- **Merge type restrictions** (all configurable):
+  - Squash merge (combines all commits into one)
+  - Rebase with merge commit (semi-linear history)
+  - Rebase and fast-forward (linear history, no merge commit)
+  - Basic merge/no fast-forward (preserves all commits and history)
+
+### Development Branch Policies
+
+- **Build validation**: Automatically runs the pipeline to validate PRs
+- **Merge type restrictions** (all configurable):
+  - Squash merge (combines all commits into one)
+  - Rebase with merge commit (semi-linear history)
+  - Rebase and fast-forward (linear history, no merge commit)
+  - Basic merge/no fast-forward (preserves all commits and history)
+
+### Pipeline
+
+- **Creates** an Azure Pipeline named after your project (configurable)
+- **Uses** a YAML file from your repository (default: `azure-pipelines.yml`, configurable)
+- **Connects** to the `main` and `development` branch
+- **Skips** the first automatic run
+
+## Prerequisites
+
+Before running this script, ensure you have:
+
+1. **Azure CLI** installed
+
+   ```bash
+   # Check if installed
+   az --version
+   
+   # Install if needed (Linux/macOS)
+   curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
+   ```
+
+2. **Azure DevOps extension** installed
+
+   ```bash
+   az extension add --name azure-devops
+   ```
+
+3. **Authenticated** to Azure
+
+   ```bash
+   az login --allow-no-subscriptions
+   ```
+
+4. **Appropriate permissions** in your Azure DevOps organization:
+   - Project Administrator or higher
+   - Or specific permissions for:
+     - Managing repository policies
+     - Creating pipelines
+     - Managing branches
+
+## Setup Instructions
+
+### Step 1: Configure Environment Variables
+
+1. Open the `azure-devops.env` file in this directory and review it.
+
+### Step 2: Run the Setup Script
+
+Execute the script from this directory:
+
+```bash
+bash setup.sh
+```
+
+Or make it executable and run directly:
+
+```bash
+chmod +x setup.sh
+./setup.sh
+```
+
+### Step 3: Verify Configuration
+
+After the script completes successfully:
+
+1. Visit your Azure DevOps repository in your browser
+2. Navigate to **Repos** → **Branches**
+3. Verify:
+   - If configured, `development` is marked as the default branch
+   - Both `main` and `development` branches have policy icons
+4. Navigate to **Pipelines** to see your new pipeline
+
+## Configuration Options
+
+All configuration is done through the `azure-devops.env` file:
+
+### Required Settings
+
+| Variable               | Description                        |
+| ---------------------- | ---------------------------------- |
+| `AZURE_DEVOPS_ORG_URL` | Your Azure DevOps organization URL |
+| `AZURE_PROJECT_NAME`   | Project name in Azure DevOps       |
+
+### Branch Settings
+
+| Variable                            | Description                               | Default                  |
+| ----------------------------------- | ----------------------------------------- | ------------------------ |
+| `REPO_NAME`                         | Repository name                           | Generated project's name |
+| `MAIN_BRANCH`                       | Name of production branch                 | `main`                   |
+| `DEV_BRANCH`                        | Name of development branch                | `development`            |
+| `SET_DEVELOPMENT_BRANCH_AS_DEFAULT` | Set dev branch as default in Azure DevOps | `true`                   |
+
+### Main Branch Policy Settings
+
+| Variable                     | Description                                      | Default |
+| ---------------------------- | ------------------------------------------------ | ------- |
+| `MIN_REVIEWERS`              | Minimum PR reviewers required                    | `1`     |
+| `MAIN_RESET_ON_SOURCE_PUSH`  | Reset approvals when new commits are pushed      | `true`  |
+| `MAIN_ALLOW_NO_FAST_FORWARD` | Allow basic merge (preserves all history)        | `false` |
+| `MAIN_ALLOW_SQUASH_MERGE`    | Allow squash merge (all commits → 1 commit)      | `true`  |
+| `MAIN_ALLOW_REBASE`          | Allow rebase and fast-forward (linear, no merge) | `false` |
+| `MAIN_ALLOW_REBASE_MERGE`    | Allow rebase with merge commit (semi-linear)     | `true`  |
+
+### Development Branch Policy Settings
+
+| Variable                    | Description                                      | Default |
+| --------------------------- | ------------------------------------------------ | ------- |
+| `DEV_ALLOW_NO_FAST_FORWARD` | Allow basic merge (preserves all history)        | `false` |
+| `DEV_ALLOW_SQUASH_MERGE`    | Allow squash merge (all commits → 1 commit)      | `true`  |
+| `DEV_ALLOW_REBASE`          | Allow rebase and fast-forward (linear, no merge) | `false` |
+| `DEV_ALLOW_REBASE_MERGE`    | Allow rebase with merge commit (semi-linear)     | `true`  |
+
+### Pipeline Settings
+
+| Variable             | Description                        | Default                  |
+| -------------------- | ---------------------------------- | ------------------------ |
+| `PIPELINE_NAME`      | Name of the pipeline to create     | Generated project's name |
+| `PIPELINE_YAML_PATH` | Path to pipeline YAML file in repo | `azure-pipelines.yml`    |
+
+## Additional Resources
+
+- [Azure DevOps CLI documentation](https://docs.microsoft.com/en-us/cli/azure/devops)
+- [Branch policies documentation](https://docs.microsoft.com/en-us/azure/devops/repos/git/branch-policies)
+- [Azure Pipelines documentation](https://docs.microsoft.com/en-us/azure/devops/pipelines/)

package/generators/setup-azure-devops/templates/scripts/setup-azure-devops/azure-devops.env

@@ -0,0 +1,113 @@
+###############################################################################
+# Azure DevOps Configuration
+#
+# This file contains configuration for the Azure DevOps setup script.
+# Please update the values below to match your Azure DevOps organization and
+# project settings.
+###############################################################################
+
+# -----------------------------------------------------------------------------
+# Azure DevOps Organization and Project
+# -----------------------------------------------------------------------------
+
+# Your Azure DevOps organization URL
+# Example: https://dev.azure.com/myorganization
+AZURE_DEVOPS_ORG_URL="<%= azureDevOpsOrgUrl %>"
+
+# The name of your Azure DevOps project
+# This is the project that contains your repository
+# You find it in the URL of your Azure DevOps project: https://dev.azure.com/YOUR_ORGANIZATION/YOUR_PROJECT_NAME/_git/REPO_NAME
+AZURE_PROJECT_NAME="<%= azureProjectName %>"
+
+# -----------------------------------------------------------------------------
+# Repository Configuration
+# -----------------------------------------------------------------------------
+
+# The name of the repository in Azure DevOps
+# Default: Project name from generator
+# You find it in the URL of your Azure DevOps repository: https://dev.azure.com/YOUR_ORGANIZATION/YOUR_PROJECT_NAME/_git/REPO_NAME
+REPO_NAME="<%= repoName %>"
+
+# -----------------------------------------------------------------------------
+# Branch Configuration
+# -----------------------------------------------------------------------------
+
+# Name of the main/production branch
+MAIN_BRANCH="<%= mainBranch %>"
+
+# Name of the development branch
+DEV_BRANCH="<%= devBranch %>"
+
+# Whether to set the development branch as the default branch in Azure DevOps
+# true = development branch becomes default (recommended for active development)
+# false = main branch stays as default
+SET_DEVELOPMENT_BRANCH_AS_DEFAULT=<%= setDevBranchAsDefault %>
+
+# -----------------------------------------------------------------------------
+# Main Branch Policy Settings
+# -----------------------------------------------------------------------------
+
+# Minimum number of reviewers required for pull requests to main
+MIN_REVIEWERS=<%= minReviewers %>
+
+# Whether approvals are reset when new commits are pushed to a PR targeting main
+# true = reviewers must re-approve after each code push (more secure)
+# false = approvals persist even after new commits (faster workflow)
+MAIN_RESET_ON_SOURCE_PUSH=<%= mainResetOnSourcePush %>
+
+# Merge strategy options for main branch:
+
+# Allow basic merge (no fast-forward) - Standard merge that preserves all commits
+# Preserves complete branch history with merge commits
+MAIN_ALLOW_NO_FAST_FORWARD=<%= mainAllowNoFastForward %>
+
+# Allow squash merge - Combines all PR commits into a single commit (recommended)
+# Creates clean, linear history
+MAIN_ALLOW_SQUASH_MERGE=<%= mainAllowSquashMerge %>
+
+# Allow rebase and fast-forward - Replays commits on target without merge commit
+# Creates completely linear history
+MAIN_ALLOW_REBASE=<%= mainAllowRebase %>
+
+# Allow rebase with merge commit - Replays commits on target then creates merge commit
+# Creates semi-linear history
+MAIN_ALLOW_REBASE_MERGE=<%= mainAllowRebaseMerge %>
+
+# Note: The script automatically:
+# - Sets creator-vote-counts to false (prohibits self-approval)
+# - Requires minimum reviewers before merge
+# - Enables build validation for PRs
+
+# -----------------------------------------------------------------------------
+# Development Branch Policy Settings
+# -----------------------------------------------------------------------------
+
+# Merge strategy options for development branch:
+
+# Allow basic merge (no fast-forward) - Standard merge that preserves all commits
+# Preserves complete branch history with merge commits
+DEV_ALLOW_NO_FAST_FORWARD=<%= devAllowNoFastForward %>
+
+# Allow squash merge - Combines all PR commits into a single commit (recommended)
+# Creates clean, linear history
+DEV_ALLOW_SQUASH_MERGE=<%= devAllowSquashMerge %>
+
+# Allow rebase and fast-forward - Replays commits on target without merge commit
+# Creates completely linear history
+DEV_ALLOW_REBASE=<%= devAllowRebase %>
+
+# Allow rebase with merge commit - Replays commits on target then creates merge commit
+# Creates semi-linear history
+DEV_ALLOW_REBASE_MERGE=<%= devAllowRebaseMerge %>
+
+# -----------------------------------------------------------------------------
+# Pipeline Configuration
+# -----------------------------------------------------------------------------
+
+# Name of the Azure Pipeline to create
+# Default: Project name from generator
+PIPELINE_NAME="<%= pipelineName %>"
+
+# Path to the pipeline YAML file in the repository
+# This file defines the build/test/deploy steps for your CI/CD pipeline
+PIPELINE_YAML_PATH="<%= pipelineYamlPath %>"