Skip to content

Add documentation for GitHub Actions working-directory configuration in multi-project solutions #4054

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
merged 5 commits into from
Jul 18, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 15, 2025

Adds comprehensive documentation to address scenarios where GitHub Actions workflows generated by azd pipeline config need manual configuration for multi-project .NET Aspire solutions.

Changes Made

Added a new section "Configure working directory for multi-project solutions" to the GitHub Actions deployment documentation that explains:

  1. When working-directory is needed: Multi-project solutions where the AppHost project is not in the repository root
  2. How to identify the issue: Generated workflows assume AppHost is in root directory
  3. Step-by-step solution: How to add working-directory parameters to workflow steps
  4. Before/after examples: Clear YAML examples showing the required changes
  5. Finding the correct path: How to identify which directory contains the AppHost project

Example scenario covered

For a repository structure like:

MyAspireApp/
├── MyAspireApp.sln
├── MyAspireApp.AppHost/
│   ├── MyAspireApp.AppHost.csproj
│   └── Program.cs
├── MyAspireApp.ApiService/
└── MyAspireApp.Web/

The documentation now shows how to update workflow steps:

- name: Provision Infrastructure
  run: azd provision --no-prompt
  working-directory: ./MyAspireApp.AppHost  # Added this line
  env:
    AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
    # ... other env vars

Documentation quality

  • Follows Microsoft Writing Style Guide conventions
  • Passes all markdown linting checks
  • Includes cross-reference to existing "Add .NET Aspire to existing app" tutorial
  • Uses clear, actionable language with step-by-step instructions

Fixes #1696.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.


Internal previews

📄 File 🔗 Preview link
docs/deployment/azure/aca-deployment-github-actions.md docs/deployment/azure/aca-deployment-github-actions

…in multi-project solutions

Co-authored-by: IEvangelist <[email protected]>
@Copilot Copilot AI changed the title [WIP] Working directory for Github action Add documentation for GitHub Actions working-directory configuration in multi-project solutions Jul 15, 2025
@Copilot Copilot AI requested a review from IEvangelist July 15, 2025 17:20
Copilot finished work on behalf of IEvangelist July 15, 2025 17:20
@IEvangelist IEvangelist marked this pull request as ready for review July 17, 2025 19:23
@IEvangelist IEvangelist requested a review from adegeo July 17, 2025 19:24
@Copilot Copilot AI requested a review from IEvangelist July 17, 2025 19:27
Copilot finished work on behalf of IEvangelist July 17, 2025 19:27
@IEvangelist IEvangelist requested a review from tdykstra July 18, 2025 14:47
Copy link
Contributor

@adegeo adegeo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved to unblock. Added some feedback.

@Copilot Copilot AI requested a review from adegeo July 18, 2025 16:19
Copilot finished work on behalf of adegeo July 18, 2025 16:19
@IEvangelist IEvangelist merged commit 6ed7b7a into main Jul 18, 2025
9 checks passed
@IEvangelist IEvangelist deleted the copilot/fix-1696 branch July 18, 2025 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Working directory for Github action
3 participants