Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
148 commits
Select commit Hold shift + click to select a range
32fa187
Update mcr.microsoft.com/dotnet/sdk:9.0.202-noble Docker digest to dc…
renovate[bot] Mar 24, 2025
c6c1f8b
Opt in to the new MicroBuild SBOM behavior
matteo-prosperi Mar 27, 2025
e9c5e82
Merge pull request #362 from matteo-prosperi/dev/maprospe/sbom
AArnott Mar 27, 2025
bc06523
Fix unofficial build with SDL tools enabled
matteo-prosperi Mar 27, 2025
5938898
Merge pull request #363 from matteo-prosperi/patch-4
AArnott Mar 28, 2025
01186f5
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Mar 29, 2025
268a3af
Update dependency xunit.v3 to v2 (#353)
renovate[bot] Apr 6, 2025
d4ce11e
Update Dockerfile and global.json updates to v9.0.203 (#364)
renovate[bot] Apr 9, 2025
95d339a
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Apr 11, 2025
2fb29d7
Update docs to use MergeFrom-Template.ps1
AArnott Apr 16, 2025
2ce8c97
Merge branch 'main' into microbuild
AArnott Apr 16, 2025
23cd85a
Fix lang service reporting C# 7.3 errors in Error List
AArnott Apr 22, 2025
3c5a02c
Merge branch 'main' into microbuild
AArnott Apr 22, 2025
095ddc2
Remove remnants of a workaround
AArnott Apr 22, 2025
24fb90c
Share more variable definitions
AArnott Apr 22, 2025
a84dfb3
Avoid CodeQL steps during release
AArnott Apr 22, 2025
5e856e2
Drop stale comment
AArnott Apr 23, 2025
2714b09
Reapply "Avoid `dotnet format` hang"
AArnott Apr 24, 2025
1aa5446
Merge branch 'main' into microbuild
AArnott Apr 24, 2025
a4fb4a4
Another CodeQL skip
AArnott Apr 24, 2025
2345213
Revert "Opt in to the new MicroBuild SBOM behavior" (#365)
AArnott Apr 24, 2025
708a205
Merge remote-tracking branch 'origin/microbuild' into microbuild_trial
AArnott Apr 24, 2025
1a8cb76
Update actions/download-artifact digest to d3f86a1
renovate[bot] Apr 28, 2025
8dc9804
Update dependency powershell to 7.5.1
renovate[bot] Apr 28, 2025
1ddad47
Update mcr.microsoft.com/dotnet/sdk:9.0.203-noble Docker digest to c8…
renovate[bot] Apr 28, 2025
638e0fb
Reapply "Opt in to the new MicroBuild SBOM behavior"
AArnott Apr 29, 2025
2b0f8e2
Merge branch 'microbuild_trial' into microbuild
AArnott Apr 29, 2025
567a574
Deploy SBOMs next to the VSIX they describe
AArnott Apr 30, 2025
508b839
Update xunit (#370)
renovate[bot] May 4, 2025
9d32400
Merge remote-tracking branch 'origin/main' into microbuild
AArnott May 5, 2025
990d9b5
Update SUPPORT.md with links to product support
AArnott May 6, 2025
fd52657
Refine SUPPORT.md wording
AArnott May 6, 2025
8fe4f14
Add support for a repo to hard-code extra SDKs that must be installed
AArnott May 6, 2025
0e0b8be
Merge pull request #371 from AArnott/multipleSDKs
AArnott May 6, 2025
3b421ec
Add script for collecting 3rd party symbol files
AArnott May 7, 2025
37b7f32
Merge branch 'main' into microbuild
AArnott May 8, 2025
5cc3d59
Reapply "Avoid `dotnet format` hang"
AArnott Apr 24, 2025
9e190e7
Merge branch 'main' into microbuild
AArnott May 8, 2025
e84bdc6
Fix 3rd party symbol archival
AArnott May 9, 2025
5ae59c1
Merge branch 'main' into microbuild
AArnott May 9, 2025
56aaaf0
Update Dockerfile and global.json updates to v9.0.300 (#372)
renovate[bot] May 14, 2025
94431e7
Update dependency Microsoft.NET.Test.Sdk to 17.14.0
AArnott May 20, 2025
c028455
Merge branch 'main' into microbuild
AArnott May 20, 2025
08b8fab
Update mcr.microsoft.com/dotnet/sdk:9.0.300-noble Docker digest to 9f…
renovate[bot] May 29, 2025
25a0aa4
Update becheran/mlc action to v0.22.0 (#374)
renovate[bot] May 29, 2025
7974fd3
Update dependency Microsoft.NET.Test.Sdk to 17.14.1
AArnott Jun 3, 2025
ae78ccb
Merge branch 'main' into microbuild
AArnott Jun 3, 2025
0d8cac2
Update becheran/mlc action to v0.22.0
AArnott Jun 5, 2025
e427b3f
Pin actions/checkout
AArnott Jun 5, 2025
df32f51
Update xunit
renovate[bot] Jun 7, 2025
0c41b21
Update Dockerfile and global.json updates to v9.0.301 (#376)
renovate[bot] Jun 11, 2025
4e511af
Add copilot swe agent setup instructions (#377)
AArnott Jun 11, 2025
ebd6a2f
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Jun 11, 2025
231dae9
Touch-up name of github workflow
AArnott Jun 11, 2025
f6217c2
Bump MicroBuild to 2.0.198
AArnott Jun 17, 2025
87df227
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Jun 17, 2025
0e6d59c
Enable PME signing for Library.Template
Jun 18, 2025
ce93bed
Fix expand-template.yml indentation
AArnott Jun 18, 2025
7830c55
Merge pull request #378 from skylarnam/dev/sknam/pme-signing
AArnott Jun 18, 2025
dd63cb0
Focus binskim on just the binaries we build
AArnott Jun 19, 2025
b432d5e
Build for OptProf with test signed bits
AArnott Jun 20, 2025
1a7db8d
Update mcr.microsoft.com/dotnet/sdk:9.0.301-noble Docker digest to 21…
renovate[bot] Jun 20, 2025
892b907
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Jun 20, 2025
f84cb0f
Update mcr.microsoft.com/dotnet/sdk:9.0.301-noble Docker digest to f3…
renovate[bot] Jun 20, 2025
d1219b5
Update dependency powershell to 7.5.2
renovate[bot] Jun 25, 2025
c14a73b
Re-enable static graph nuget restore
AArnott Jun 29, 2025
73b7e11
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Jul 1, 2025
5396018
Update becheran/mlc action to v1 (#383)
renovate[bot] Jul 8, 2025
d9522ff
Update mcr.microsoft.com/dotnet/sdk:9.0.301-noble Docker digest to 23…
renovate[bot] Jul 8, 2025
200f811
Update mcr.microsoft.com/dotnet/sdk:9.0.301-noble Docker digest to 4f…
renovate[bot] Jul 8, 2025
0f78e95
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Jul 8, 2025
11467d8
Update .NET SDK to v9.0.302
renovate[bot] Jul 9, 2025
68b60df
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Jul 9, 2025
eef5eee
Update dependency xunit.v3 to v3 (#387)
renovate[bot] Jul 14, 2025
6b1c4db
Update dependency xunit.runner.visualstudio to 3.1.2 (#386)
renovate[bot] Jul 14, 2025
a075ec8
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Jul 14, 2025
43aadc1
Skip CodeQL scanning of test code
AArnott Jul 15, 2025
2102e05
Update mcr.microsoft.com/dotnet/sdk:9.0.302-noble Docker digest to d4…
renovate[bot] Jul 15, 2025
f17cd2a
Run Component Detection explicitly before Notice
pieandcakes Jul 16, 2025
56e2404
Run Component Detection explicitly before Notice (#392)
AArnott Jul 16, 2025
fe71729
Update dependency xunit.runner.visualstudio to 3.1.3
renovate[bot] Jul 16, 2025
77f38d4
Update Dockerfile and global.json updates to v9.0.303 (#394)
renovate[bot] Jul 18, 2025
3d3b0ba
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Jul 23, 2025
b6f67cc
Bump MicroBuildVersion to 2.0.199
AArnott Jul 24, 2025
6483557
Update becheran/mlc action to v1
AArnott Jul 25, 2025
8eb458b
Disable credscan task on unofficial builds
AArnott Jul 26, 2025
28382fd
Update mcr.microsoft.com/dotnet/sdk:9.0.303-noble Docker digest to a9…
renovate[bot] Jul 30, 2025
f9374d9
Pass through System.AccessToken when real signing on non-Windows buil…
tydunkel Jul 30, 2025
6f665e4
Update mcr.microsoft.com/dotnet/sdk:9.0.303-noble Docker digest to 14…
renovate[bot] Jul 31, 2025
d82349d
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Aug 3, 2025
c2b6afa
Update Dockerfile and global.json updates to v9.0.304
renovate[bot] Aug 5, 2025
eb42f5f
Update actions/download-artifact action to v5 (#399)
renovate[bot] Aug 6, 2025
801d690
Update mcr.microsoft.com/dotnet/sdk:9.0.304-noble Docker digest to 1f…
renovate[bot] Aug 6, 2025
193a34a
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Aug 6, 2025
78241e3
Add copilot-instructions.md file
AArnott Aug 9, 2025
5e1fec3
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Aug 9, 2025
28cfd93
Fix up contributing to work better on linux
AArnott Aug 10, 2025
c4de4d0
Add copilot instructions about avoiding unstable tests
AArnott Aug 10, 2025
7f486cc
Update actions/checkout action to v5 (#402)
renovate[bot] Aug 11, 2025
dc3950f
Update xunit
renovate[bot] Aug 16, 2025
6dc6ace
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Aug 16, 2025
04843ad
Update actions/checkout action to v5
AArnott Aug 17, 2025
90069e4
Update mcr.microsoft.com/dotnet/sdk:9.0.304-noble Docker digest to 0b…
renovate[bot] Aug 20, 2025
640b1d1
Update actions/upload-pages-artifact action to v4 (#405)
renovate[bot] Aug 22, 2025
3c0717a
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Aug 25, 2025
6e77b79
Move GitHub workflow token permissions to per-job
AArnott Aug 25, 2025
ef68ecc
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Aug 28, 2025
3c9a9fa
Move Install-NuGetPackage.ps1 to the tools folder
AArnott Aug 28, 2025
53aebc9
Update hyperlinks to learn.microsoft.com
AArnott Sep 5, 2025
af9d6a5
Merge branch 'main' into microbuild
AArnott Sep 5, 2025
8cf1387
Update hyperlinks to learn.microsoft.com
AArnott Sep 5, 2025
25e8285
Remove stray backtick from CONTRIBUTING.md
AArnott Sep 8, 2025
4d2be89
Add `Install-NuGetPackage.ps1` script
AArnott Sep 8, 2025
c29f9af
Add switches to Install-NuGetPackage.ps1
AArnott Sep 8, 2025
fec70cf
Update Dockerfile and global.json updates to v9.0.305
renovate[bot] Sep 9, 2025
be3bba6
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Sep 10, 2025
d71cf66
Update mcr.microsoft.com/dotnet/sdk:9.0.305-noble Docker digest to 80…
renovate[bot] Sep 10, 2025
1367101
Drop extra `Pop-Location` from `Install-NuGetPackage.ps1`
AArnott Sep 10, 2025
6241068
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Sep 10, 2025
e40d505
Update dependency powershell to v7.5.3
renovate[bot] Sep 10, 2025
761109a
Add API compat testing
AArnott Sep 11, 2025
b199798
Switch API compat testing from dotnet tool to MSBuild
AArnott Sep 11, 2025
31d3166
Merge pull request #410 from AArnott/apicompat
AArnott Sep 11, 2025
dfa8f35
Migrate from managed identity to service connection for APIScan (#409)
trevors20 Sep 11, 2025
28cf28e
Migrate from managed identity to service connection for symbol archiv…
matteo-prosperi Sep 16, 2025
028c074
Bump MicroBuild version to 2.0.201
AArnott Sep 17, 2025
ce5bb3c
Update .gitignore source URL
AArnott Sep 17, 2025
60bc0ad
Drop explicit nuget.org source for procdump
AArnott Sep 17, 2025
f959aef
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Sep 17, 2025
0f75208
Allow VSInsertion artifact collection with just a VSIX
AArnott Sep 17, 2025
0e1fe34
Fix Microsoft.DiaSymReader.Pdb2Pdb package installation
AArnott Sep 17, 2025
fe66868
Fix VSIX placement to match .vsman expectations
AArnott Sep 18, 2025
af11e11
Fix stray period in doc
AArnott Sep 18, 2025
eef43c7
Merge branch 'microbuild_staging' into microbuild
AArnott Sep 18, 2025
2ccc242
Merge branch 'main' into microbuild
AArnott Sep 18, 2025
b936253
Use newer SBOM tool
AArnott Sep 18, 2025
85815ca
Bump nuget.exe to 6.14.0
AArnott Sep 19, 2025
e0b565c
Merge branch 'main' into microbuild
AArnott Sep 19, 2025
caf1204
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Sep 24, 2025
7bfb1d6
Update mcr.microsoft.com/dotnet/sdk:9.0.305-noble Docker digest to 60…
renovate[bot] Sep 24, 2025
0ec755f
Don't check npmjs.com doc links
AArnott Sep 26, 2025
04923ff
Add dotnet-tools.json to Solution Items
AArnott Sep 26, 2025
0b8462e
Skip testing get.dot.net links
AArnott Sep 26, 2025
a0fe97a
Update nbgv and nerdbank.gitversioning updates to 3.8.118 (#416)
renovate[bot] Sep 26, 2025
0983188
Merge remote-tracking branch 'origin/main' into microbuild
AArnott Sep 26, 2025
b41d6ea
Merge the microbuild branch from https://github.com/aarnott/Library.T…
ttstanley Sep 26, 2025
3ba2f4e
update nerdbrank version
ttstanley Sep 26, 2025
884cc16
update tools for dotnet for nbgv
ttstanley Sep 26, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .config/dotnet-tools.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"isRoot": true,
"tools": {
"powershell": {
"version": "7.5.0",
"version": "7.5.3",
"commands": [
"pwsh"
],
Expand Down
2 changes: 1 addition & 1 deletion .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions
FROM mcr.microsoft.com/dotnet/sdk:9.0.202-noble@sha256:332e0362dd210a10348d436a5fb7f87aeec28c2c53ac2c3c2659e57c22294d0e
FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:604ef064c6d91068eeb9d946036d8ffadbe25589c4cd77a230fc96e0f6d01d72

# Installing mono makes `dotnet test` work without errors even for net472.
# But installing it takes a long time, so it's excluded by default.
Expand Down
23 changes: 23 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Copilot instructions for this repository

## High level guidance

* Review the `CONTRIBUTING.md` file for instructions to build and test the software.
* Set the `NBGV_GitEngine` environment variable to `Disabled` before running any `dotnet` or `msbuild` commands.

## Software Design

* Design APIs to be highly testable, and all functionality should be tested.
* Avoid introducing binary breaking changes in public APIs of projects under `src` unless their project files have `IsPackable` set to `false`.

## Testing

* There should generally be one test project (under the `test` directory) per shipping project (under the `src` directory). Test projects are named after the project being tested with a `.Test` suffix.
* Tests should use the Xunit testing framework.
* Some tests are known to be unstable. When running tests, you should skip the unstable ones by running `dotnet test --filter "TestCategory!=FailsInCloudTest"`.

## Coding style

* Honor StyleCop rules and fix any reported build warnings *after* getting tests to pass.
* In C# files, use namespace *statements* instead of namespace *blocks* for all new files.
* Add API doc comments to all new public and internal members.
41 changes: 41 additions & 0 deletions .github/workflows/copilot-setup-steps.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: 💪🏼 Copilot Setup Steps

# Automatically run the setup steps when they are changed to allow for easy validation, and
# allow manual testing through the repository's "Actions" tab
on:
workflow_dispatch:
push:
branches:
- main
paths:
- .github/workflows/copilot-setup-steps.yml
pull_request:
paths:
- .github/workflows/copilot-setup-steps.yml

jobs:
# The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
copilot-setup-steps:
runs-on: ubuntu-latest
# Set the permissions to the lowest permissions possible needed for your steps.
# Copilot will be given its own token for its operations.
permissions:
# If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
contents: read

# You can define any steps you want, and they will run before the agent starts.
# If you do not check out your code, Copilot will do this for you.
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
with:
fetch-depth: 0 # avoid shallow clone so nbgv can do its work.
- name: ⚙ Install prerequisites
run: |
./init.ps1 -UpgradePrerequisites -NoNuGetCredProvider
dotnet --info

# Print mono version if it is present.
if (Get-Command mono -ErrorAction SilentlyContinue) {
mono --version
}
shell: pwsh
17 changes: 8 additions & 9 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,6 @@ on:
branches:
- main

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
actions: read
pages: write
id-token: write
contents: read

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
Expand All @@ -20,12 +13,18 @@ concurrency:

jobs:
publish-docs:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
actions: read
pages: write
id-token: write
contents: read
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
with:
fetch-depth: 0 # avoid shallow clone so nbgv can do its work.
- name: ⚙ Install prerequisites
Expand All @@ -35,7 +34,7 @@ jobs:
name: 📚 Generate documentation

- name: Upload artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4
with:
path: docfx/_site

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/docs_validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ jobs:
name: 📚 Doc validation
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
with:
fetch-depth: 0 # avoid shallow clone so nbgv can do its work.
- name: 🔗 Markup Link Checker (mlc)
uses: becheran/mlc@v0.21.0
uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0
with:
args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://msrc.microsoft.com/*,https://www.microsoft.com/msrc*,https://microsoft.com/msrc*
args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://msrc.microsoft.com/*,https://www.microsoft.com/msrc*,https://microsoft.com/msrc*,https://www.npmjs.com/package/*,https://get.dot.net/
- name: ⚙ Install prerequisites
run: |
./init.ps1 -UpgradePrerequisites
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/libtemplate-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
contents: write
pull-requests: write
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
with:
fetch-depth: 0 # avoid shallow clone so nbgv can do its work.

Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore

# User-specific files
*.rsuser
Expand Down
22 changes: 18 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This repository can be built on Windows, Linux, and OSX.

Building, testing, and packing this repository can be done by using the standard dotnet CLI commands (e.g. `dotnet build`, `dotnet test`, `dotnet pack`, etc.).

[pwsh]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell?view=powershell-6
[pwsh]: https://learn.microsoft.com/powershell/scripting/install/installing-powershell

## Releases

Expand All @@ -52,9 +52,9 @@ Push the tag.
When your repo is hosted by GitHub and you are using GitHub Actions, you should create a GitHub Release using the standard GitHub UI.
Having previously used `nbgv tag` and pushing the tag will help you identify the precise commit and name to use for this release.

After publishing the release, the `.github\workflows\release.yml` workflow will be automatically triggered, which will:
After publishing the release, the `.github/workflows/release.yml` workflow will be automatically triggered, which will:

1. Find the most recent `.github\workflows\build.yml` GitHub workflow run of the tagged release.
1. Find the most recent `.github/workflows/build.yml` GitHub workflow run of the tagged release.
1. Upload the `deployables` artifact from that workflow run to your GitHub Release.
1. If you have `NUGET_API_KEY` defined as a secret variable for your repo or org, any nuget packages in the `deployables` artifact will be pushed to nuget.org.

Expand All @@ -65,7 +65,7 @@ Trigger the pipeline by adding the `auto-release` tag on a run of your main `azu

## Tutorial and API documentation

API and hand-written docs are found under the `docfx/` directory. and are built by [docfx](https://dotnet.github.io/docfx/).
API and hand-written docs are found under the `docfx/` directory and are built by [docfx](https://dotnet.github.io/docfx/).

You can make changes and host the site locally to preview them by switching to that directory and running the `dotnet docfx --serve` command.
After making a change, you can rebuild the docs site while the localhost server is running by running `dotnet docfx` again from a separate terminal.
Expand All @@ -81,3 +81,17 @@ Configuration is in the `.github/renovate.json` file.
When changing the renovate.json file, follow [these validation steps](https://docs.renovatebot.com/config-validation/).

If Renovate is not creating pull requests when you expect it to, check that the [Renovate GitHub App](https://github.com/apps/renovate) is configured for your account or repo.

## Merging latest from Library.Template

### Maintaining your repo based on this template

The best way to keep your repo in sync with Library.Template's evolving features and best practices is to periodically merge the template into your repo:

```ps1
git fetch
git checkout origin/main
./tools/MergeFrom-Template.ps1
# resolve any conflicts, then commit the merge commit.
git push origin -u HEAD
```
3 changes: 3 additions & 0 deletions CodeQL.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
path_classifiers:
library:
- 'test/**'
15 changes: 13 additions & 2 deletions Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,23 @@
<BaseOutputPath Condition=" '$(BaseOutputPath)' == '' ">$(RepoRootPath)bin\$(MSBuildProjectName)\</BaseOutputPath>
<PackageOutputPath>$(RepoRootPath)bin\Packages\$(Configuration)\NuGet\</PackageOutputPath>
<VSIXOutputPath>$(RepoRootPath)bin\Packages\$(Configuration)\Vsix\$(Platform)\</VSIXOutputPath>
<VSIXOutputPath Condition="'$(Platform)'=='' or '$(Platform)'=='AnyCPU'">$(RepoRootPath)bin\Packages\$(Configuration)\Vsix\</VSIXOutputPath>
<SBOMFileDestPath>$(VSIXOutputPath)</SBOMFileDestPath>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<AnalysisLevel>latest</AnalysisLevel>
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<ProduceReferenceAssembly>true</ProduceReferenceAssembly>

<!-- https://learn.microsoft.com/en-us/dotnet/fundamentals/apicompat/package-validation/overview -->
<EnablePackageValidation>true</EnablePackageValidation>

<!-- https://github.com/dotnet/msbuild/blob/main/documentation/ProjectReference-Protocol.md#setplatform-negotiation -->
<EnableDynamicPlatformResolution>true</EnableDynamicPlatformResolution>

<!-- Opt in till https://github.com/NuGet/Home/issues/9803 makes this the default. -->
<!-- Opt back out until an SDK with the fix for https://github.com/NuGet/Home/issues/12177 is generally available. -->
<RestoreUseStaticGraphEvaluation>false</RestoreUseStaticGraphEvaluation>
<RestoreUseStaticGraphEvaluation>true</RestoreUseStaticGraphEvaluation>

<!-- This entire repo has just one version.json file, so compute the version once and share with all projects in a large build. -->
<GitVersionBaseDirectory>$(MSBuildThisFileDirectory)</GitVersionBaseDirectory>
Expand All @@ -38,6 +42,11 @@
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
</PropertyGroup>

<PropertyGroup>
<LangVersion Condition="'$(MSBuildProjectExtension)'=='.csproj'">13</LangVersion>
<LangVersion Condition="'$(MSBuildProjectExtension)'=='.vbproj'">16.9</LangVersion>
</PropertyGroup>

<ItemGroup>
<None Include="$(RepoRootPath)obj/NOTICE" Pack="true" PackagePath="" Visible="false" Condition=" Exists('$(RepoRootPath)obj/NOTICE') " />
</ItemGroup>
Expand All @@ -56,4 +65,6 @@
<PackageReleaseNotes Condition="'$(RepositoryUrl)'!=''">$(RepositoryUrl)/releases/tag/v$(Version)</PackageReleaseNotes>
</PropertyGroup>
</Target>

<Import Project="azure-pipelines\NuGetSbom.props" />
</Project>
6 changes: 0 additions & 6 deletions Directory.Build.targets
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<Project>
<PropertyGroup>
<LangVersion Condition="'$(Language)'=='C#'">13</LangVersion>
<LangVersion Condition="'$(Language)'=='VB'">16.9</LangVersion>
</PropertyGroup>
<ItemGroup>
<!-- Avoid compile error about missing namespace when combining ImplicitUsings with .NET Framework target frameworks. -->
<Using Remove="System.Net.Http" Condition="'$(TargetFrameworkIdentifier)'=='.NETFramework'" />
</ItemGroup>

<Import Project="azure-pipelines\NuGetSbom.targets" Condition="'$(IsPackable)'!='false'" />
</Project>
11 changes: 9 additions & 2 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<PropertyGroup>
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
<CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
<MicroBuildVersion>2.0.171</MicroBuildVersion>
<MicroBuildVersion>2.0.201</MicroBuildVersion>
</PropertyGroup>
<ItemGroup>
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
Expand All @@ -15,14 +15,21 @@
<PackageVersion Include="System.Diagnostics.FileVersionInfo" Version="4.3.0" />
<PackageVersion Include="System.Runtime.Serialization.Formatters" Version="4.3.0" />
</ItemGroup>
<ItemGroup Label="Library.Template">
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
<PackageVersion Include="Microsoft.VisualStudio.Internal.MicroBuild.NonShipping" Version="$(MicroBuildVersion)" />
<PackageVersion Include="xunit.runner.visualstudio" Version="3.1.4" />
<PackageVersion Include="xunit.v3" Version="3.0.1" />
</ItemGroup>
<ItemGroup>
<!-- Put repo-specific GlobalPackageReference items in this group. -->
</ItemGroup>
<ItemGroup Label="Library.Template">
<GlobalPackageReference Include="CSharpIsNullAnalyzer" Version="0.1.593" />
<GlobalPackageReference Include="DotNetAnalyzers.DocumentationAnalyzers" Version="1.0.0-beta.59" />
<GlobalPackageReference Include="Microsoft.VisualStudio.Internal.MicroBuild.VisualStudio" Version="$(MicroBuildVersion)" />
<GlobalPackageReference Include="Nerdbank.GitVersioning" Version="3.7.115" />
<!-- The condition works around https://github.com/dotnet/sdk/issues/44951 -->
<GlobalPackageReference Include="Nerdbank.GitVersioning" Version="3.7.115" Condition="!('$(TF_BUILD)'=='true' and '$(dotnetformat)'=='true')" />
<GlobalPackageReference Include="PolySharp" Version="1.15.0" />
<GlobalPackageReference Include="StyleCop.Analyzers.Unstable" Version="1.2.0.556" />
</ItemGroup>
Expand Down
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
JSON Document Transfoms
============
[![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Jdt.svg)](https://nuget.org/packages/Microsoft.VisualStudio.Jdt)
[![Build status](https://ci.appveyor.com/api/projects/status/xi1ufnfhnhh5e31m/branch/master?svg=true)](https://ci.appveyor.com/project/jviau/json-document-transforms/branch/master)
JSON Document Transforms (JDT) library. Perform transformations on JSON files using another JSON as the specification. This is the C# implementation.
For more information on how JDT works, see the [JDT Wiki](https://github.com/Microsoft/json-document-transforms/wiki)
This project has adopted the [Microsoft Open Source Code of
Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct
FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com)
with any additional questions or comments.
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
JSON Document Transfoms
============
[![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Jdt.svg)](https://nuget.org/packages/Microsoft.VisualStudio.Jdt)
[![Build status](https://ci.appveyor.com/api/projects/status/xi1ufnfhnhh5e31m/branch/master?svg=true)](https://ci.appveyor.com/project/jviau/json-document-transforms/branch/master)

JSON Document Transforms (JDT) library. Perform transformations on JSON files using another JSON as the specification. This is the C# implementation.

For more information on how JDT works, see the [JDT Wiki](https://github.com/Microsoft/json-document-transforms/wiki)

This project has adopted the [Microsoft Open Source Code of
Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct
FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com)
with any additional questions or comments.

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).

If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://learn.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.

## Reporting Security Issues

Expand Down
6 changes: 3 additions & 3 deletions SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## How to file issues and get help

This project uses GitHub Issues to track bugs and feature requests. Please search the existing
issues before filing new issues to avoid duplicates. For new issues, file your bug or
feature request as a new Issue.
This project uses GitHub Issues to track bugs and feature requests.
Please search the existing issues before filing new issues to avoid duplicates.
For new issues, file your bug or feature request as a new Issue.

For help and questions about using this project, please create an issue.

Expand Down
Loading