-
Notifications
You must be signed in to change notification settings - Fork 830
Add Azure DevOps template for F# compiler regression testing #19121
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+825
−21
Merged
Changes from 3 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
b3a9813
Initial plan
Copilot 89b3637
Add Azure DevOps template for F# compiler regression testing
Copilot f9523da
Address code review feedback: update net10.0 documentation and fix XP…
Copilot 960283e
Fix regression testing: standalone F# script, move template to stage …
Copilot bdd9d02
Fix regression test job registration with correct template structure …
Copilot 0bd6f76
Fix template structure: add dash before each loop to properly emit jobs
Copilot 0fe78d0
Address review feedback: job name order, SDK version, and binlog coll…
Copilot c0641bd
Fix trailing whitespace
Copilot e392883
Add VSO error reporting with local reproduction steps for failed tests
Copilot be0e81d
Fix VSO error reporting: remove hardcoded line number, fix bash varia…
Copilot f3e1228
Add .NET 8 SDK installation and fix VSO error reporting with multilin…
Copilot 58cc556
Fix git submodule initialization for FSharpPlus type providers
Copilot 6f5b60d
Fix artifact path structure to match UseLocalCompiler.Directory.Build…
Copilot 18e09ae
Fix binlog generation: use dotnet pack with -bl flag instead of fake …
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| # Design Decisions | ||
|
|
||
| This document records significant design decisions made during the implementation of the F# Compiler Regression Testing pipeline. | ||
|
|
||
| ## Decision 1: Template-Based Architecture | ||
|
|
||
| **Context**: Need to implement regression testing that can be reused across pipelines. | ||
|
|
||
| **Options Considered**: | ||
| 1. Inline job definitions in azure-pipelines-PR.yml | ||
| 2. Reusable Azure DevOps template in eng/templates/ | ||
|
|
||
| **Decision**: Use reusable template approach. | ||
|
|
||
| **Rationale**: | ||
| - Follows Azure DevOps best practices | ||
| - Reduces code duplication | ||
| - Makes it easy to extend with new libraries | ||
| - Consistent with existing patterns in the repository (eng/common/templates/) | ||
|
|
||
| --- | ||
|
|
||
| ## Decision 2: Optimized Artifact Publishing | ||
|
|
||
| **Context**: Need to share compiler artifacts between jobs. | ||
|
|
||
| **Options Considered**: | ||
| 1. Publish entire artifacts folder (~1.8GB) | ||
| 2. Publish only essential directories (fsc and FSharp.Core) (~79MB) | ||
|
|
||
| **Decision**: Publish only essential directories. | ||
|
|
||
| **Rationale**: | ||
| - Reduces artifact size from 1.8GB to ~79MB | ||
| - Faster artifact upload/download | ||
| - Contains all necessary components for regression testing | ||
| - Matches approach in previous PR #18803 | ||
|
|
||
| --- | ||
|
|
||
| ## Decision 3: Using F# Script for Directory.Build.props Setup | ||
|
|
||
| **Context**: Need to inject UseLocalCompiler.Directory.Build.props import into third-party repos. | ||
|
|
||
| **Options Considered**: | ||
| 1. Pure PowerShell XML manipulation | ||
| 2. F# script with proper XML handling | ||
| 3. Simple file replacement | ||
|
|
||
| **Decision**: Use F# script with XML handling. | ||
|
|
||
| **Rationale**: | ||
| - Properly handles existing Directory.Build.props files | ||
| - Correctly inserts import at beginning of Project element | ||
| - Native F# tooling in an F# project | ||
| - Matches approach in previous PR #18803 | ||
|
|
||
| --- | ||
|
|
||
| ## Decision 4: Specific Commit SHAs for Third-Party Libraries | ||
|
|
||
| **Context**: Need reproducible regression tests. | ||
|
|
||
| **Options Considered**: | ||
| 1. Use main/master branch | ||
| 2. Use specific commit SHAs | ||
|
|
||
| **Decision**: Use specific commit SHAs. | ||
|
|
||
| **Rationale**: | ||
| - Ensures reproducible test results | ||
| - Protects against breaking changes in third-party libraries | ||
| - Allows controlled updates when ready | ||
| - Standard practice for regression testing | ||
|
|
||
| --- | ||
|
|
||
| ## Decision 5: Removal of Strategy Matrix from EndToEndBuildTests | ||
|
|
||
| **Context**: The original EndToEndBuildTests job had a matrix for regular vs experimental features. | ||
|
|
||
| **Options Considered**: | ||
| 1. Keep the matrix and publish artifacts only from one configuration | ||
| 2. Remove the matrix entirely | ||
| 3. Publish artifacts from both configurations | ||
|
|
||
| **Decision**: Remove the matrix entirely (per previous PR approach). | ||
|
|
||
| **Rationale**: | ||
| - Simplifies artifact publishing | ||
| - Regression tests need consistent baseline | ||
| - Both configurations were building with empty experimental flag anyway | ||
| - Matches approach in previous PR #18803 | ||
|
|
||
| --- | ||
|
|
||
| ## Decision 6: Use net10.0 Target Framework in Template | ||
|
|
||
| **Context**: The pipeline needs to reference the correct .NET target framework for the compiler artifacts. | ||
|
|
||
| **Options Considered**: | ||
| 1. Hardcode net9.0 (as in PR #18803) | ||
| 2. Use net10.0 (per current UseLocalCompiler.Directory.Build.props) | ||
| 3. Make it configurable | ||
|
|
||
| **Decision**: Use net10.0 to match the current project state. | ||
|
|
||
| **Rationale**: | ||
| - The current repository uses .NET 10 SDK | ||
| - UseLocalCompiler.Directory.Build.props references net10.0 paths | ||
| - The artifacts/bin/fsc/Release/net10.0 directory exists | ||
| - PR #18803 used net9.0 because it was based on an older version of the repository | ||
| - Using net10.0 ensures compatibility with the current build output | ||
|
|
||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Obstacles Encountered | ||
|
|
||
| This document tracks any obstacles encountered during the implementation of the Azure DevOps regression testing template. | ||
|
|
||
| ## Current Obstacles | ||
|
|
||
| None at this time. | ||
|
|
||
| ## Resolved Obstacles | ||
|
|
||
| _(None yet)_ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # TODO: Azure DevOps Template for F# Compiler Regression Testing | ||
|
|
||
| ## Overview | ||
| Implement a reusable Azure DevOps template for F# compiler regression testing, integrated with the existing PR pipeline infrastructure. | ||
|
|
||
| ## Tasks | ||
|
|
||
| ### Infrastructure Setup | ||
| - [x] Analyze existing PR pipeline structure (`azure-pipelines-PR.yml`) | ||
| - [x] Review previous PR #18803 implementation details | ||
| - [x] Understand `UseLocalCompiler.Directory.Build.props` configuration | ||
|
|
||
| ### Implementation | ||
| - [x] Create `eng/templates/` directory | ||
| - [x] Create `eng/templates/regression-test-jobs.yml` template | ||
| - [x] Define parameters for testMatrix | ||
| - [x] Implement job that depends on EndToEndBuildTests | ||
| - [x] Add artifact download steps (FSharpCompilerFscArtifacts, FSharpCoreArtifacts, UseLocalCompilerProps) | ||
| - [x] Add third-party repo checkout step | ||
| - [x] Add .NET SDK installation step | ||
| - [x] Add Directory.Build.props setup step with F# script | ||
| - [x] Add environment reporting step | ||
| - [x] Add build execution step | ||
| - [x] Add artifact publishing step | ||
| - [x] Add result reporting step | ||
|
|
||
| ### Integration | ||
| - [x] Update `azure-pipelines-PR.yml`: | ||
| - [x] Modify EndToEndBuildTests to publish focused artifacts | ||
| - [x] Remove strategy/matrix section from EndToEndBuildTests | ||
| - [x] Add artifact publishing tasks for fsc, FSharp.Core, and UseLocalCompiler props | ||
| - [x] Add template invocation with FSharpPlus test matrix | ||
|
|
||
| ### Documentation | ||
| - [x] Create `docs/regression-testing-pipeline.md` | ||
| - [x] Purpose and overview | ||
| - [x] How it works | ||
| - [x] Current test matrix | ||
| - [x] Adding new libraries | ||
| - [x] Pipeline configuration | ||
| - [x] Troubleshooting | ||
| - [x] Technical details | ||
|
|
||
| ### Validation | ||
| - [x] Verify YAML syntax is valid | ||
| - [x] Verify template structure matches Azure DevOps best practices | ||
| - [x] Ensure Release configuration is used throughout | ||
|
|
||
| ## References | ||
| - Previous PR: https://github.com/dotnet/fsharp/pull/18803 | ||
| - Files: `eng/templates/regression-test-jobs.yml`, `azure-pipelines-PR.yml`, `docs/regression-testing-pipeline.md` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.