Return objects from psake scripts #29
Merged
Conversation
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
This addresses a common question about how to return data from psake scripts, such as artifact URLs or build metadata. The new documentation covers: - Script-level variables for simple data - Output files (JSON/YAML) for CI/CD integration - Environment variables for pipeline integration - BuildTearDown for centralized reporting - Anti-patterns to avoid - Complete working examples The documentation is added to the Tutorial - Advanced section as it covers patterns for working with build outputs and artifacts.
✅ Deploy Preview for psake ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The previous version incorrectly stated that script-level variables could be used to return data from psake to the calling script. This is wrong because psake executes the build file in its own scope. Key corrections: - Removed script-level variables as primary recommendation - Made output files (JSON/YAML) the #1 recommended approach - Added clear anti-pattern section explaining why script variables don't work outside psake invocations - Distinguished between inter-task communication (script vars work) and returning data from psake (must use files) - Added direct answer to original question at top of file output section Thanks to the user for catching this fundamental error.
HeyItsGilbert
commented
Nov 26, 2025
| exit 0 | ||
| ``` | ||
|
|
||
| **Answer to the original question:** For your use case of returning a hashtable with an `ArtifactUrl` field, write it to a JSON file as shown above. This is the standard, reliable approach. |
Member
Author
There was a problem hiding this comment.
Remove this. We don't use "Answer" anywhere else.
Comment on lines
215
to
255
| ### 4. BuildTearDown for Centralized Reporting | ||
|
|
||
| Use `BuildTearDown` to generate summary reports or outputs that run after all tasks complete (even on failure). | ||
|
|
||
| ```powershell title="psakefile.ps1" | ||
| # Track build metadata | ||
| $script:BuildMetrics = @{ | ||
| TasksExecuted = @() | ||
| StartTime = $null | ||
| EndTime = $null | ||
| ArtifactUrl = $null | ||
| } | ||
|
|
||
| BuildSetup { | ||
| $script:BuildMetrics.StartTime = Get-Date | ||
| } | ||
|
|
||
| TaskSetup { | ||
| $taskName = $psake.context.Peek().currentTaskName | ||
| $script:BuildMetrics.TasksExecuted += $taskName | ||
| } | ||
|
|
||
| BuildTearDown { | ||
| $script:BuildMetrics.EndTime = Get-Date | ||
| $duration = $script:BuildMetrics.EndTime - $script:BuildMetrics.StartTime | ||
|
|
||
| # Create summary report (IMPORTANT: Write to file, not just variables) | ||
| $summary = @{ | ||
| Success = $psake.build_success | ||
| Duration = $duration.TotalSeconds | ||
| TasksExecuted = $script:BuildMetrics.TasksExecuted | ||
| ArtifactUrl = $script:BuildMetrics.ArtifactUrl | ||
| Timestamp = (Get-Date).ToString("o") | ||
| } | ||
|
|
||
| # Write to file so it's accessible after Invoke-psake completes | ||
| $summary | ConvertTo-Json | Set-Content ./build-summary.json | ||
|
|
||
| Write-Host "`n========== Build Summary ==========" -ForegroundColor Cyan | ||
| Write-Host "Status: $(if ($psake.build_success) { 'SUCCESS' } else { 'FAILED' })" | ||
| Write-Host "Duration: $($duration.TotalSeconds) seconds" |
Member
Author
There was a problem hiding this comment.
BuildTearDown, BuildSetup, are not valid commands. TaskSetup and TaskTearDown are commands, but they run before and after each task.
1. Removed "Answer to the original question" callout as requested 2. Removed entire "BuildTearDown for Centralized Reporting" section - BuildSetup and BuildTearDown are not valid psake commands - TaskSetup and TaskTearDown exist but run before/after each task 3. Updated Best Practices Summary to remove BuildTearDown reference 4. Updated Quick Reference table to remove BuildTearDown row 5. Updated See Also links to remove BuildTearDown mention All references to the non-existent BuildSetup/BuildTearDown commands have been removed from the documentation.
HeyItsGilbert
deleted the
claude/psake-object-return-016fDSLBaTGgtru8wmHKu6Ap
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This addresses a common question about how to return data from psake scripts, such as artifact URLs or build metadata. The new documentation covers:
The documentation is added to the Tutorial - Advanced section as it covers patterns for working with build outputs and artifacts.