Skip to content

Commit

Permalink
Merge pull request #1897 from dotnet/main
Browse files Browse the repository at this point in the history
✅ Merge `main` into `live`
  • Loading branch information
dotnet-policy-service[bot] authored Oct 26, 2024
2 parents 585bfa4 + 713cd1d commit 0783b39
Show file tree
Hide file tree
Showing 4 changed files with 137 additions and 1 deletion.
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/04-breaking-change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: ".NET Aspire breaking change"
description: Report a change in .NET Aspire that breaks something that worked in a previous version. Intended mostly for product-team use.
title: "[Breaking change]: "
labels:
- "⛓️‍💥 breaking-change"
- Pri1
- doc-idea
assignees:
- IEvangelist
body:
- type: textarea
id: description
attributes:
label: Description
description: Brief description of the breaking change.
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of .NET Aspire introduced the breaking change?
options:
- .NET Aspire 9.0 GA
- .NET Aspire 9.0 RC1
- Other (please put exact version in description textbox)
validations:
required: true
- type: textarea
id: old-behavior
attributes:
label: Previous behavior
description: Describe the previous behavior.
validations:
required: true
- type: textarea
id: new-behavior
attributes:
label: New behavior
description: Describe the new behavior. Include code snippets if applicable.
validations:
required: true
- type: checkboxes
id: change-type
attributes:
label: Type of breaking change
description: This information will be used to label the issue appropriately. [(How do I decide?)](https://learn.microsoft.com/dotnet/core/compatibility/categories)
options:
- label: "**Binary incompatible**: Existing binaries might encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation."
- label: "**Source incompatible**: When recompiled using the new SDK or component or to target the new runtime, existing source code might require source changes to compile successfully."
- label: "**Behavioral change**: Existing binaries might behave differently at run time."
- type: textarea
id: reason
attributes:
label: Reason for change
description: Describe why the breaking change was introduced.
validations:
required: true
- type: textarea
id: recommended-action
attributes:
label: Recommended action
description: Describe the recommended action an affected user should take, such as workarounds or examples of code changes.
validations:
required: true
- type: textarea
id: affected-apis
attributes:
label: Affected APIs
description: List all the APIs affected by this change. For methods, clarify if it's all overloads or specific overloads.
- type: markdown
attributes:
value: |
Finally, please email a link to this breaking change issue to [.NET Breaking Change Notifications](mailto:[email protected]).
57 changes: 57 additions & 0 deletions .github/workflows/create-monthly-issues.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Create monthly issues

on:
schedule:
- cron: '0 0 24 * *' # Runs at midnight on the 24th of each month

permissions:
contents: read

jobs:
create-issue:
runs-on: ubuntu-latest
permissions:
issues: write

steps:
- name: Harden Runner
uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit

- name: Create GitHub Issue
uses: actions/github-script@660ec11d825b714d112a6bb9727086bc2cc500b2 #v7
with:
script: |
const nextMonth = new Date();
const currentMonth = nextMonth.getMonth();
if (currentMonth === 11) { // December
nextMonth.setMonth(0); // January
nextMonth.setFullYear(nextMonth.getFullYear() + 1);
} else {
nextMonth.setMonth(currentMonth + 1);
}
const monthName = nextMonth.toLocaleString('default', { month: 'short' });
const year = nextMonth.getFullYear();
const monthEmojis = ['❄️', '❤️', '🌸', '🌧️', '🌼', '☀️', '🎆', '🌞', '🍂', '🎃', '🍁', '🎄'];
const month = nextMonth.getMonth();
const emoji = monthEmojis[month];
const issueTitle = `${emoji} Repo chores—${monthName} ${year}`;
const issueBody = `
- [ ] Check *An external link was removed to protect your privacy.* for \`dotnet/docs-aspire\`
- [ ] Fix build suggestions in \`dotnet/docs-aspire\`
- [ ] Check *An external link was removed to protect your privacy.* for \`dotnet/docs-aspire\`
- [ ] Approve/merge CleanRepo PR
- [ ] Clean up hygiene items in *An external link was removed to protect your privacy.*
> [!NOTE]
> 🤖 This issue was created using [.github/workflows/create-monthly-issues.yml](https://github.com/dotnet/docs-aspire/blob/main/.github/workflows/create-monthly-issues.yml).
`;
github.issues.create({
owner: context.repo.owner,
repo: context.repo.repo,
title: issueTitle,
body: issueBody,
labels: ['Pri1', '⚙️ repo-maintenance'],
assignees: ['IEvangelist']
});
1 change: 0 additions & 1 deletion docs/deployment/manifest-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Manifest generation is achieved by running `dotnet build` with a special target:

```dotnetcli
dotnet run --project AspireApp.AppHost\AspireApp.AppHost.csproj `
-- `
--publisher manifest `
--output-path ../aspire-manifest.json
```
Expand Down
6 changes: 6 additions & 0 deletions docs/diagnostics/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Several APIs of .NET Aspire are decorated with the <xref:System.Diagnostics.Code

## AZPROVISION001

<span id="AZPROVISION001"></span>

.NET Aspire provides various overloads for Azure Provisioning resource types (from the `Azure.Provisioning` package). The overloads are used to create resources with different configurations. The overloads are experimental and may be removed or changed in future versions of .NET Aspire.

To suppress this diagnostic with the `SuppressMessageAttribute`, add the following code to your project:
Expand All @@ -31,6 +33,8 @@ Alternatively, you can suppress this diagnostic with preprocessor directive by a

## ASPIREACADOMAINS001

<span id="ASPIREACADOMAINS001"></span>

.NET Aspire 9.0 introduces the ability to customize container app resources using the `PublishAsAzureContainerApp(...)` extension method. When using this method the Azure Developer CLI (`azd`) can no longer preserve custom domains. Instead use the `ConfigureCustomDomain` method to configure a custom domain within the .NET Aspire app host. The `ConfigureCustomDomain(...)` extension method is experimental. To suppress the compiler error/warning use the following code:

To suppress this diagnostic with the `SuppressMessageAttribute`, add the following code to your project:
Expand All @@ -51,6 +55,8 @@ Alternatively, you can suppress this diagnostic with preprocessor directive by a

## ASPIREHOSTINGPYTHON001

<span id="ASPIREHOSTINGPYTHON001"></span>

.NET Aspire provides a way to add Python executables or applications to the .NET Aspire app host. Since the shape of this API is expected to change in the future, it has been marked as _Experimental_. To suppress the compiler error/warning use the following code:

To suppress this diagnostic with the `SuppressMessageAttribute`, add the following code to your project file:
Expand Down

0 comments on commit 0783b39

Please sign in to comment.