Skip to content

Commit fa9d515

Browse files
Remove outdated specifications and documentation for the settings-driven workflow configuration. This includes the data model, implementation plan, quickstart guide, research findings, and feature specification files. These changes streamline the repository by eliminating redundant or obsolete content related to the configuration system.
1 parent 2dfe6ad commit fa9d515

File tree

7 files changed

+15
-1612
lines changed

7 files changed

+15
-1612
lines changed

README.md

Lines changed: 15 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ Depending on the labels in the pull requests, the workflow will result in differ
2424

2525
![Process diagram](./media/Process-PSModule.png)
2626

27-
- [Get-Settings](./.github/workflows/Get-Settings.yml)
27+
- [Get Settings](./.github/workflows/Get-Settings.yml)
2828
- **Workflow orchestration phase** that analyzes context and makes smart execution decisions
29-
- **Collects Configuration**: Reads the settings file from `.github/PSModule.yml` (or JSON/PSD1) to configure the workflow
29+
- **Collects Configuration**: Reads the settings file from `.github/PSModule.yml` to configure the workflow
3030
- **Analyzes Context**: Examines GitHub event type, PR state, labels, and repository structure
3131
- **Makes Smart Decisions**: Determines which workflow jobs should execute based on collected data
3232
- **Prepares Test Matrices**: Generates dynamic test suite configurations for parallel execution across OSes
@@ -72,41 +72,23 @@ Depending on the labels in the pull requests, the workflow will result in differ
7272
- Publishes the module to the PowerShell Gallery.
7373
- Creates a release on the GitHub repository.
7474

75-
## Gather Phase: Workflow Orchestration
75+
## Workflow Orchestration
7676

77-
The **Gather** phase is the cornerstone of Process-PSModule's workflow execution, providing context-aware orchestration for CI/CD pipelines.
78-
79-
### Philosophy
80-
81-
The Gather phase embodies the principle of **deployment orchestration**:
77+
The **Get-Settings** phase is the cornerstone of Process-PSModule's workflow execution, providing context-aware orchestration for CI/CD pipelines.
8278

8379
- **Discovers the Environment**: Analyzes the GitHub context (event type, PR state, labels, branch)
84-
- **Loads Configuration**: Reads settings from `.github/PSModule.yml` (or JSON/PSD1 format)
85-
- **Makes Context-Aware Decisions**: Determines which jobs should execute based on collected data
80+
- **Loads Configuration**: Reads settings from `.github/PSModule.yml` with fallback to defaults
81+
- **Context Analysis**: Examines whether the workflow is running on:
82+
- Open/Updated PR (build and test for validation)
83+
- Merged PR (publish release and deploy site)
84+
- Abandoned PR (cleanup only)
85+
- Manual/Scheduled run (validation only)
86+
- **Test Matrix Generation**: Creates OS-specific test configurations based on:
87+
- Available test files in the repository
88+
- Skip flags in settings
89+
- Test type requirements (SourceCode, PSModule, Module)
8690
- **Optimizes Resource Usage**: Skips unnecessary steps to reduce CI/CD runtime and costs
87-
- **Prepares Execution Plan**: Generates dynamic test matrices for parallel execution across platforms
88-
89-
### What Gather Does
90-
91-
1. **Configuration Loading**: Imports settings with fallback to defaults
92-
2. **Context Analysis**: Examines whether the workflow is running on:
93-
- Open/Updated PR (build and test for validation)
94-
- Merged PR (publish release and deploy site)
95-
- Abandoned PR (cleanup only)
96-
- Manual/Scheduled run (validation only)
97-
3. **Test Matrix Generation**: Creates OS-specific test configurations based on:
98-
- Available test files in the repository
99-
- Skip flags in settings
100-
- Test type requirements (SourceCode, PSModule, Module)
101-
4. **Decision Output**: Produces structured outputs that control downstream job execution
102-
103-
### Key Benefits
104-
105-
- **Consistency**: Same logic across all consuming repositories
106-
- **Efficiency**: Only runs necessary jobs for each scenario
107-
- **Flexibility**: Easy to customize via settings file
108-
- **Transparency**: Clear decision-making visible in workflow logs
109-
- **Maintainability**: Centralized orchestration logic
91+
- **Decision and settings output**: Produces structured outputs that control downstream job execution
11092

11193
This approach ensures that each workflow run is optimized for its specific context, reducing unnecessary work while maintaining comprehensive validation when needed.
11294

specs/001-settings-driven-workflow/contracts/configuration-schema.md

Lines changed: 0 additions & 326 deletions
This file was deleted.

0 commit comments

Comments
 (0)