š§¹ Monorepo Cleanup
See original GitHub issueThis is a long development ticket to be split in the future. This is just a conversation starter around what āneeds to be doneā
Weāve been collecting some dust on our Monorepo that is quite normal on a project this size, but itās time to give it a quick (or not so quickā¦) polish!
Please edit this list and add any items that need to be discussed
Things that can be done immediately:
- Have a single .editorconfig on the monorepo root
- Use Directory.Build.props (and .targets) to share common properties across projects (Company, copyright, copy to objects folder after buildā¦)
- Make
All.sln
the only solution in the repo, usesolution filters instead
to select specific parts of the solution. This allows for the build configurations to be stored in a single solution, making editing faster. A single solution also makes it impossible to have projects missing in one solution or another. - Enable Style and Code Quality analyzers
- Choose a language version to apply by default.
Things that require each team memberās involvement:
- Uniform target frameworks (when available) or at least minimise the amount of versions we use.
- Upgrade all our projects to SDK style (thereās a migration tool that works great). This will allow us to remove
MSBuild.AssemblyVersion
, enabling the whole solution to build withdotnet build
. Would speed up CI and reduce credit cost by allowing us to build on linux. > This may or may not be fully feasible. Must be checked per project
Potentially disruptive actions:
- Do a solution-wide reformat to ensure all code complies with .editorconfig in root. THIS SHOULD BE DONE PER CONNECTOR, 1 AT A TIME, to allow each owner to choose when is the best moment to do this.
Things that need discussing, but are not blockers:
- Use Central Package Management and lock files (this + CircleCI caching should speed up restoring time considerably) https://learn.microsoft.com/en-us/nuget/consume-packages/central-package-management
- Style and analyzer rules (weāll start with ārecommendedā set but weāll disable some)
- Code Style formatting (https://csharpier.com or other?)
- Coreowners (potential for more specific entries in the
CODEOWNERS
file. @JR-Morgan mentioned a few places in core where heād like to be pinged for changes. And Iām sure there are parts of Core/Objects that some people would like the opportunity to give feedback on changes)
Some of this changes will imply a change in our CI to some degree. In theory we could replace our calls to a sln
file to a slnf
(solution filter) and it should just work as normal, but it remains to be tested.
Issue Analytics
- State:
- Created 6 months ago
- Reactions:2
- Comments:6 (6 by maintainers)
Top Results From Across the Web
Braden1996/monorepo-template
A moderately opinionated monorepo template for launching an Expo mobile app and Next website w/ shared code and storybook powered design systems.
Read more >Let's clean up chaos ā managing multiple Javascript ...
Monorepo is one of the approaches to manage packages in complex projects. All packages are located in the same git repository,Ā ...
Read more >Monorepo Spring Cleaning [Workshop] - Git Merge 2022
Presented by Preston MartinIn this workshop, participants will work through exercises and get tips and tricks to help learn how to manageĀ ...
Read more >Jairaj Sahgal posted about Monorepo vs Microrepos
Monorepo vs Microrepos: Which One is Right for Your Company? ... A cleanup champ! š§¹ PROTECT: Prevent deletion of the referenced object if...
Read more >[Typescript] TS Monorepo setup - Zhentiw
lerna run clean : cleanup all the linked packages include node_modules all in one go. lerna run build : it will run the...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Closing this as the vast majority of the work has been done. Iāll open separate tickets for whatās left
Added suggestion to use Central Package Management + Lock files
https://devblogs.microsoft.com/nuget/enable-repeatable-package-restores-using-a-lock-file/ https://learn.microsoft.com/en-us/nuget/consume-packages/central-package-management