Skip to content

API review of Steeltoe.Common #1334

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

Merged
merged 30 commits into from
Aug 16, 2024
Merged

API review of Steeltoe.Common #1334

merged 30 commits into from
Aug 16, 2024

Conversation

bart-vmware
Copy link
Member

@bart-vmware bart-vmware commented Aug 14, 2024

Description

Public API review of Steeltoe.Common (first part). See the individual commit messages for details.

Closes #898, closes #897, closes #825, closes #928, closes #916, closes #929, closes #941, closes #946, closes #947, closes #590, closes #962, closes #1257, closes #1271.

Quality checklist

  • Your code complies with our Coding Style.
  • 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.
  • 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.
  • 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.

…sages:

- File/directory name can consist of whitespace
- Configuration key can consist of whitespace
- Logger category name can consist of whitespace
- Assembly/type/member name can NOT consist of whitespace
- Hostname/url can NOT consist of whitespace
- Eureka app-name/instance-ID/VIP-address can NOT consist of whitespace

Use ToArray() instead of ToList(), which is slightly more efficient
The following configuration keys are no longer being read, as they were never meant to be:
- application:name
- application:uris
- consul:serviceName
- management:name
- spring:application:instance_id

Renames:
- IServiceCollection.RegisterDefaultApplicationInstanceInfo -> AddApplicationInstanceInfo
- IServiceCollection.RegisterCloudFoundryApplicationInstanceInfo -> AddCloudFoundryOptions (unified with other extension methods)
…c-comments, make Add*ActuatorServices extension methods internal
…nsafe when used from multiple Steeltoe components)
…ors, unify test contributors into single type
@bart-vmware bart-vmware added this to the 4.0.0 milestone Aug 14, 2024
@bart-vmware bart-vmware marked this pull request as ready for review August 14, 2024 16:13
@bart-vmware
Copy link
Member Author

/azp run cleanup-code

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@bart-vmware
Copy link
Member Author

bart-vmware commented Aug 15, 2024

/azp run Steeltoe.All

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Copy link

Code cleanup successfully reformatted files, but there were no changes to push.

@bart-vmware bart-vmware changed the title Common api review API review of Steeltoe.Common Aug 15, 2024
@bart-vmware bart-vmware requested a review from TimHess August 15, 2024 06:32
Copy link
Member

@TimHess TimHess left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good to me, a few questions, comments and minor changes to make

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Copy link

Copy link
Member

@TimHess TimHess left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bart-vmware bart-vmware merged commit e4c84b2 into main Aug 16, 2024
22 checks passed
@bart-vmware bart-vmware deleted the common-api-review branch August 16, 2024 13:53
@TimHess TimHess modified the milestones: 4.0.0, 4.0.0-m1 Sep 13, 2024
@bart-vmware bart-vmware added the ReleaseLine/4.x Identified as a feature/fix for the 4.x release line label Jan 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment