Skip to content
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

Document the .NET SDK Artifacts Output Layout for .NET 8 #36446

Closed
baronfel opened this issue Jul 28, 2023 · 1 comment · Fixed by #37824
Closed

Document the .NET SDK Artifacts Output Layout for .NET 8 #36446

baronfel opened this issue Jul 28, 2023 · 1 comment · Fixed by #37824
Assignees
Labels
doc-idea Indicates issues that are suggestions for new topics [org][type][category] 📌 seQUESTered Identifies that an issue has been imported into Quest.

Comments

@baronfel
Copy link
Member

baronfel commented Jul 28, 2023

Describe the new article

In .NET 8 the .NET SDK added support for a feature we're calling the 'artifacts output format', which is a centralized, simplified layout for project outputs that tackles several long-standing user reports about pain points working with 'standard' SDK artifact layouts. This layout was designed here and implemented here.

We need to document the new layout, how it's computed, how it's enabled, and how it can be customized.

Key points:

  • The feature is best configured through use of a Directory.Build.props file (new concept to a lot of folks, we have an easy way to get started with one in the CLI now)
  • The default layout is four levels only now: <root>/<artifact type>/<project name>/<pivots>
  • The feature has some properties that control its use:
    • UseArtifactsOutput - boolean property that controls if the feature is used at all
    • ArtifactsPath - string property that controls where the new 'root' of the layout will begin (defaults to a directory named 'artifacts' in the repo next to the Directory.Build.props (if any))
    • ArtifactsPivots - string property that allows for customizing the <pivots> the artifacts go into
      • defaults to a combination of TFM, Configuration, RID (dropping any of those that are not present)

We can reference the preview 3 and preview 4 blog post updates for this feature for content as well.


Document Details

Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

  • ID: 47d5789d-4edb-3d22-9a8a-fdad704b8384
  • Version Independent ID: c92f0188-38cb-c658-5f1b-e2a3ce2d34e9
  • Content: .NET SDK overview
  • Content Source: docs/core/sdk.md
  • Product: dotnet-fundamentals
  • Technology: dotnet-cli
  • GitHub Login: @gewarren
  • Microsoft Alias: dotnetcontent

Associated WorkItem - 166836

@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Jul 28, 2023
@gewarren
Copy link
Contributor

@gewarren gewarren added the doc-idea Indicates issues that are suggestions for new topics [org][type][category] label Aug 29, 2023
@gewarren gewarren self-assigned this Aug 29, 2023
@gewarren gewarren added the 🗺️ reQUEST Triggers an issue to be imported into Quest. label Oct 2, 2023
@github-actions github-actions bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Oct 3, 2023
@ghost ghost added the in-pr This issue will be closed (fixed) by an active pull request. label Oct 31, 2023
@gewarren gewarren moved this from 🔖 Ready to 👀 In review in dotnet/docs October 2023 sprint Oct 31, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in dotnet/docs October 2023 sprint Nov 1, 2023
@ghost ghost removed the in-pr This issue will be closed (fixed) by an active pull request. label Nov 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-idea Indicates issues that are suggestions for new topics [org][type][category] 📌 seQUESTered Identifies that an issue has been imported into Quest.
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants