Steeltoe icon indicating copy to clipboard operation
Steeltoe copied to clipboard

Consolidate Base & Core packages

Open TimHess opened this issue 3 years ago • 13 comments

Description

These changes remove the Base/Core naming convention, consolidate packages where possible, remove some obsolete packages and alter namespaces in some cases where Base/Core were present and shouldn't have been.

Fixes #973

Quality checklist

  • [x] Your code complies with our Coding Style.
  • [x] You've updated unit and/or integration tests for your change, where applicable.
  • [ ] You've updated documentation for your change, where applicable. If your change affects other repositories, such as Documentation, Samples and/or MainSite, add linked PRs here.
  • [x] There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.
  • [x] You've added required license files and/or file headers (explaining where the code came from with proper attribution), where code is copied from StackOverflow, a blog, or OSS.

TimHess avatar Aug 03 '22 21:08 TimHess

Looking for thoughts/opinions on this question: Is it worth the effort to produce new Base and Core packages that exist purely to make the transition to the new package names? If so, how and when should we do that?

TimHess avatar Aug 10 '22 21:08 TimHess

/azp run Steeltoe.All

TimHess avatar Aug 10 '22 21:08 TimHess

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines[bot] avatar Aug 10 '22 21:08 azure-pipelines[bot]

/azp run cleanup-code

bart-vmware avatar Aug 11 '22 08:08 bart-vmware

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines[bot] avatar Aug 11 '22 08:08 azure-pipelines[bot]

Code cleanup successfully reformatted files and pushed changes.

azure-pipelines[bot] avatar Aug 11 '22 09:08 azure-pipelines[bot]

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines[bot] avatar Aug 11 '22 10:08 azure-pipelines[bot]

The file git.properties occurs 4 times in the source tree, likely originating from https://github.com/git-commit-id/git-commit-id-maven-plugin. There's also variants, such as empty.git.properties and garbage.git.properties.

Can these be removed and added to /.gitignore? Note: to get them actually deleted, change .gitignore in a separate commit after deleting the files. I wonder what happens when this PR gets merged, so maybe merge this PR as a merge-commit, just to be safe.

Update: references to these files occur in *.csproj files to hide them from Solution Explorer.

bart-vmware avatar Aug 11 '22 12:08 bart-vmware

The file AspNetCoreHostingObserverTest.cs was moved into Metrics subfolder, but the class is marked as:

[Obsolete("To be removed in the next major version.")]

Can it be removed instead?

bart-vmware avatar Aug 11 '22 12:08 bart-vmware

The file git.properties occurs 4 times in the source tree, likely originating from https://github.com/git-commit-id/git-commit-id-maven-plugin. There's also variants, such as empty.git.properties and garbage.git.properties.

Can these be removed and added to /.gitignore? Note: to get them actually deleted, change .gitignore in a separate commit after deleting the files. I wonder what happens when this PR gets merged, so maybe merge this PR as a merge-commit, just to be safe.

Update: references to these files occur in *.csproj files to hide them from Solution Explorer.

I think all of these files exist for testing different conditions with the GitInfoContributor - if we remove them from source then we'll need another way to run those tests

TimHess avatar Aug 11 '22 12:08 TimHess

The file git.properties occurs 4 times in the source tree, likely originating from https://github.com/git-commit-id/git-commit-id-maven-plugin. There's also variants, such as empty.git.properties and garbage.git.properties. Can these be removed and added to /.gitignore? Note: to get them actually deleted, change .gitignore in a separate commit after deleting the files. I wonder what happens when this PR gets merged, so maybe merge this PR as a merge-commit, just to be safe. Update: references to these files occur in *.csproj files to hide them from Solution Explorer.

I think all of these files exist for testing different conditions with the GitInfoContributor - if we remove them from source then we'll need another way to run those tests

Ok, we should keep them then. I wondered if they were accidental checkins.

bart-vmware avatar Aug 11 '22 12:08 bart-vmware

The file AspNetCoreHostingObserverTest.cs was moved into Metrics subfolder, but the class is marked as:

[Obsolete("To be removed in the next major version.")]

Can it be removed instead?

This test class appears to be marked Obsolete by mistake... AspNetCoreHostingObserver is not Obsolete, so I'll remove the attribute from this test

TimHess avatar Aug 11 '22 20:08 TimHess

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines[bot] avatar Aug 15 '22 19:08 azure-pipelines[bot]

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines[bot] avatar Aug 15 '22 19:08 azure-pipelines[bot]

@TimHess Perhaps the next article helps in getting users migrated to the new packages: https://learn.microsoft.com/en-us/nuget/nuget-org/deprecate-packages#client-experience-for-deprecated-packages:

Visual Studio warns about a deprecated package's usage on the Installed tab. It will show a warning for the package and its deprecation information (including the reason it was deprecated and the alternate package to use instead, if present).

It's also possible to migrate the number of downloads to the new packages, to make them show up at the top of search results.

bart-vmware avatar Sep 19 '22 13:09 bart-vmware