Maintainability Roadmap
@mikeharder is already working on this.
Since Mar 21, 2024.
Assessment
This issue has not been assessed yet.
Description
A potential roadmap to improve maintainability, ending with the archiving of this repo.
TypeScript
- Update
SwaggerBreakingChangesinopenapi-alpsto callnpm exec --no oadinstead of@azure/oad@~0.10.6 - Move code to
azure-rest-api-specsrepo, foldereng/tools/openapi-diff - Align deps and config with
typespec-validation, add toeng/package.json - Upgrade all dependencies to latest
- If some are really difficult we can choose to stay back, but anything older than latest is a liability
- Remove .NET code from package, replace with call to nuget/dotnet to install and run separate .NET package
- Existing CLI name
oadseems good and short, and aligns withtsv- But could rename cli to
openapi-diffto be more descriptive
- But could rename cli to
- Deprecate npm package
@azure/oad
.NET
- Move code to
azure-sdk-toolsrepo, foldertools/openapi-diff - Rename to
Azure.Sdk.Tools.OpenApiDiff - Align deps and config from a similar existing tool, perhaps
http-fault-injector - Publish nuget package and/or dotnet tool to devops nuget feed (similar to
http-fault-injector) - Could potentially move code to
azure-rest-api-specs, and compile dynamically- But it would be the first .NET code in the repo
- It would add a dependency on .NET SDK (rather than just .NET runtime)
Docs
- Move docs to
azure-rest-api-specsrepo
Final
- Archive this repo (
Azure/openapi-diff)
- Dominant language
- C#
- Stars
- 290
- Forks
- 50
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 10
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/openapi-diff
-
Azure/openapi-diff#482 · 1 assignee ·
-
Azure/openapi-diff#479 · 2 comments · 1 assignee ·
-
Azure/openapi-diff#456 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Azure/openapi-diff#445 ·
-
Azure/openapi-diff#371 · 7 comments · 1 assignee ·
All issues in Azure/openapi-diff
Similar issues
-
Documentation
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
cake-build/cake#5024 ·
-
Frontend status/draft TechnicalDebt
Difficulty 2/5 1-2 days Newbie friendliness 75/100
Altinn/altinn-auth#4143 ·
-
.NET Flaky Test Testing Tests
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
getsentry/sentry-dotnet#5617 · 1 comment ·
-
:watch: Not Triaged dotnet-fsharp/svc
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Client customer-reported needs-team-attention question Service Attention WebPubSub
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Azure/azure-sdk-for-net#63292 · 3 comments · 1 reaction ·