Skip to content
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

chore: Change the way we reference Common and JMESPath (internal references). #641

Merged

Conversation

hjgraca
Copy link
Contributor

@hjgraca hjgraca commented Aug 29, 2024

Please provide the issue number

Issue number: #626

Summary

Changes

This change will stop the copy of common for each project and do that at build time only.
This setup simplifies the configuration, it treats Common and JMESPath as implementation details of the Idempotency package.

This approach should:

  • Include Common and JMESPath for compilation in the Idempotency project
  • Not copy the Common and JMESPath DLLs to the output directory of projects that reference Idempotency
  • Ensure that when the Idempotency package is created, it includes the necessary parts of Common and JMESPath
  • Work consistently across Debug and Release builds

Replace PrivateAssets=all and simplify Directory.Build.targets.
with

<Private>false</Private>
<ExcludeAssets>runtime</ExcludeAssets>

This comes after removing JMESPath from Directory.Build.targets #627 and an issue with idempotency #626

User experience

Please share what the user experience looks like before and after this change

Checklist

Please leave checklist items unchecked if they do not apply to your change.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@auto-assign auto-assign bot requested review from amirkaws and sliedig August 29, 2024 16:21
@boring-cyborg boring-cyborg bot added area/idempotency area/logging Core logging utility area/metrics Core metrics utility area/parameters area/tracing Core tracing utility labels Aug 29, 2024
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 29, 2024
@github-actions github-actions bot added the internal Maintenance changes label Aug 29, 2024
Copy link

codecov bot commented Aug 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.45%. Comparing base (4029b08) to head (f9f313c).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #641      +/-   ##
===========================================
- Coverage    72.78%   72.45%   -0.33%     
===========================================
  Files          190      190              
  Lines         7886     7886              
  Branches       850      850              
===========================================
- Hits          5740     5714      -26     
- Misses        1857     1878      +21     
- Partials       289      294       +5     
Flag Coverage Δ
unittests 72.45% <ø> (-0.33%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@amirkaws amirkaws left a comment

Choose a reason for hiding this comment

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

LGTM

@hjgraca hjgraca merged commit 63c740f into aws-powertools:develop Aug 30, 2024
10 of 11 checks passed
@hjgraca hjgraca deleted the fix(references)-build-targets-common branch August 30, 2024 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/idempotency area/logging Core logging utility area/metrics Core metrics utility area/parameters area/tracing Core tracing utility internal Maintenance changes size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants