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

docs: add migration guide for const to function manager providers #1013

Merged
merged 2 commits into from
Nov 21, 2024

Conversation

davidlj95
Copy link
Owner

@davidlj95 davidlj95 commented Oct 31, 2024

Issue or need

In #1004 / #1005 a deprecation with schematics is introduced due to #960. Users may look in docs on how to fix the deprecated symbols

More docs could be added to inform about more deprecations.

Proposed changes

In order to keep users informed about how to automatically (or manually) migrate, add a new section in docs to inform about that.

Emoji chosen for deprecations is the same one as rust. To avoid choosing emojis at random. See rust-lang/rust#67872

Quick reminders

  • 🤝 I will follow Code of Conduct
  • No existing pull request already does almost same changes
  • 👁️ Contributing docs are something I've taken a look at
  • 📝 Commit messages convention has been followed
  • 💬 TSDoc comments have been added or updated indicating API visibility if API surface has changed.
  • 🧪 Tests have been added if needed. For instance, if adding new features or fixing a bug. Or removed if removing features.
  • ⚙️ API Report has been updated if API surface is altered.

@davidlj95 davidlj95 added the preview docs Enables previewing docs in a PR label Oct 31, 2024
Copy link
Owner Author

davidlj95 commented Oct 31, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link

github-actions bot commented Oct 31, 2024

📦 Bundle size (Angular v17)

Git ref: 8e8e3340d03b08a8d332ee6bc5dc2987f0818518

Module file Size Base size Difference
ngx-meta-core.mjs 3205 bytes (3.2KiB) 3205 bytes (3.2KiB) No change
ngx-meta-json-ld.mjs 219 bytes (219B) 219 bytes (219B) No change
ngx-meta-open-graph.mjs 1033 bytes (1.1KiB) 1033 bytes (1.1KiB) No change
ngx-meta-routing.mjs 394 bytes (394B) 394 bytes (394B) No change
ngx-meta-standard.mjs 943 bytes (943B) 943 bytes (943B) No change
ngx-meta-twitter-card.mjs 539 bytes (539B) 539 bytes (539B) No change
Total 6333 bytes (6.2KiB) 6333 bytes (6.2KiB) No change

Copy link

github-actions bot commented Oct 31, 2024

📦 Bundle size (Angular v16)

Git ref: 8e8e3340d03b08a8d332ee6bc5dc2987f0818518

Module file Size Base size Difference
ngx-meta-core.mjs 3411 bytes (3.4KiB) 3411 bytes (3.4KiB) No change
ngx-meta-json-ld.mjs 193 bytes (193B) 193 bytes (193B) No change
ngx-meta-open-graph.mjs 804 bytes (804B) 804 bytes (804B) No change
ngx-meta-routing.mjs 379 bytes (379B) 379 bytes (379B) No change
ngx-meta-standard.mjs 739 bytes (739B) 739 bytes (739B) No change
ngx-meta-twitter-card.mjs 470 bytes (470B) 470 bytes (470B) No change
Total 5996 bytes (5.9KiB) 5996 bytes (5.9KiB) No change

Copy link

github-actions bot commented Oct 31, 2024

📦 Bundle size (Angular v15)

Git ref: 8e8e3340d03b08a8d332ee6bc5dc2987f0818518

Module file Size Base size Difference
ngx-meta-core.mjs 3386 bytes (3.4KiB) 3386 bytes (3.4KiB) No change
ngx-meta-json-ld.mjs 198 bytes (198B) 198 bytes (198B) No change
ngx-meta-open-graph.mjs 804 bytes (804B) 804 bytes (804B) No change
ngx-meta-routing.mjs 373 bytes (373B) 373 bytes (373B) No change
ngx-meta-standard.mjs 739 bytes (739B) 739 bytes (739B) No change
ngx-meta-twitter-card.mjs 412 bytes (412B) 412 bytes (412B) No change
Total 5912 bytes (5.8KiB) 5912 bytes (5.8KiB) No change

Copy link

github-actions bot commented Oct 31, 2024

📦 Bundle size (Angular v18)

Git ref: 8e8e3340d03b08a8d332ee6bc5dc2987f0818518

Module file Size Base size Difference
ngx-meta-core.mjs 3205 bytes (3.2KiB) 3205 bytes (3.2KiB) No change
ngx-meta-json-ld.mjs 219 bytes (219B) 219 bytes (219B) No change
ngx-meta-open-graph.mjs 1033 bytes (1.1KiB) 1033 bytes (1.1KiB) No change
ngx-meta-routing.mjs 394 bytes (394B) 394 bytes (394B) No change
ngx-meta-standard.mjs 943 bytes (943B) 943 bytes (943B) No change
ngx-meta-twitter-card.mjs 539 bytes (539B) 539 bytes (539B) No change
Total 6333 bytes (6.2KiB) 6333 bytes (6.2KiB) No change

Copy link

codecov bot commented Oct 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7d91ee6) to head (8e8e334).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1013   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           90        90           
  Lines          440       440           
  Branches        49        49           
=========================================
  Hits           440       440           

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


🚨 Try these New Features:

@davidlj95 davidlj95 force-pushed the stacked/feat-add-migration-schematic-for-breaking-changes branch from a419553 to bee8336 Compare November 20, 2024 18:32
@davidlj95 davidlj95 force-pushed the stacked/docs-add-migration-guide-for-breaking-change branch from 720486d to 9d5a757 Compare November 20, 2024 18:32
@davidlj95 davidlj95 force-pushed the stacked/feat-add-migration-schematic-for-breaking-changes branch from bee8336 to 6eaff2b Compare November 20, 2024 20:23
@davidlj95 davidlj95 force-pushed the stacked/docs-add-migration-guide-for-breaking-change branch from 9d5a757 to 9d6417b Compare November 20, 2024 20:23
@davidlj95 davidlj95 force-pushed the stacked/feat-add-migration-schematic-for-breaking-changes branch from 6eaff2b to 009374d Compare November 21, 2024 10:13
@davidlj95 davidlj95 force-pushed the stacked/docs-add-migration-guide-for-breaking-change branch from 9d6417b to f98fe3c Compare November 21, 2024 10:13
@davidlj95 davidlj95 force-pushed the stacked/docs-add-migration-guide-for-breaking-change branch from f98fe3c to 5a29fd5 Compare November 21, 2024 11:51
@davidlj95 davidlj95 changed the base branch from stacked/feat-add-migration-schematic-for-breaking-changes to main November 21, 2024 11:51
@davidlj95 davidlj95 force-pushed the stacked/docs-add-migration-guide-for-breaking-change branch from 5a29fd5 to 8e8e334 Compare November 21, 2024 11:54
@davidlj95 davidlj95 merged commit e0cacac into main Nov 21, 2024
35 checks passed
@davidlj95 davidlj95 deleted the stacked/docs-add-migration-guide-for-breaking-change branch November 21, 2024 12:03
@davidlj95 davidlj95 changed the title docs: add migration guide for breaking change docs: add migration guide for const to function manager providers Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preview docs Enables previewing docs in a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant