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 reminder about values setting in defaults guide #775

Conversation

davidlj95
Copy link
Owner

@davidlj95 davidlj95 commented Aug 13, 2024

Issue or need

When adding the library to one of my projects, found out that defaults were not being applied. Turns out neither routing module had been provided or NgxMetaService.set was called, so nothing happened.

Fixes #776

Proposed changes

Remember in defaults guide that a metadata values setting process must happen in order for defaults to be applied

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 enabled auto-merge (squash) August 13, 2024 01:34
Copy link
Owner Author

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

Join @davidlj95 and the rest of your teammates on Graphite Graphite

Copy link

📦 Bundle size (Angular v17)

Git ref: b012473ddda9f1dc3f395d72e5ff1da9bf945d30

Module file Size Base size Difference
ngx-meta-core.mjs 3108 bytes (3.1KiB) Not available Not available
ngx-meta-json-ld.mjs 226 bytes (226B) Not available Not available
ngx-meta-open-graph.mjs 899 bytes (899B) Not available Not available
ngx-meta-routing.mjs 843 bytes (843B) Not available Not available
ngx-meta-standard.mjs 990 bytes (990B) Not available Not available
ngx-meta-twitter-card.mjs 510 bytes (510B) Not available Not available
Total 6576 bytes (6.5KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

Copy link

📦 Bundle size (Angular v15)

Git ref: b012473ddda9f1dc3f395d72e5ff1da9bf945d30

Module file Size Base size Difference
ngx-meta-core.mjs 3513 bytes (3.5KiB) Not available Not available
ngx-meta-json-ld.mjs 386 bytes (386B) Not available Not available
ngx-meta-open-graph.mjs 1246 bytes (1.3KiB) Not available Not available
ngx-meta-routing.mjs 1009 bytes (1009B) Not available Not available
ngx-meta-standard.mjs 1089 bytes (1.1KiB) Not available Not available
ngx-meta-twitter-card.mjs 667 bytes (667B) Not available Not available
Total 7910 bytes (7.8KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

Copy link

📦 Bundle size (Angular v16)

Git ref: b012473ddda9f1dc3f395d72e5ff1da9bf945d30

Module file Size Base size Difference
ngx-meta-core.mjs 3513 bytes (3.5KiB) Not available Not available
ngx-meta-json-ld.mjs 386 bytes (386B) Not available Not available
ngx-meta-open-graph.mjs 1246 bytes (1.3KiB) Not available Not available
ngx-meta-routing.mjs 1009 bytes (1009B) Not available Not available
ngx-meta-standard.mjs 1089 bytes (1.1KiB) Not available Not available
ngx-meta-twitter-card.mjs 667 bytes (667B) Not available Not available
Total 7910 bytes (7.8KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

Copy link

📦 Bundle size (Angular v18)

Git ref: b012473ddda9f1dc3f395d72e5ff1da9bf945d30

Module file Size Base size Difference
ngx-meta-core.mjs 3108 bytes (3.1KiB) Not available Not available
ngx-meta-json-ld.mjs 226 bytes (226B) Not available Not available
ngx-meta-open-graph.mjs 899 bytes (899B) Not available Not available
ngx-meta-routing.mjs 843 bytes (843B) Not available Not available
ngx-meta-standard.mjs 990 bytes (990B) Not available Not available
ngx-meta-twitter-card.mjs 510 bytes (510B) Not available Not available
Total 6576 bytes (6.5KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

Copy link

codecov bot commented Aug 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.42%. Comparing base (3205f08) to head (b012473).
Report is 46 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #775   +/-   ##
=======================================
  Coverage   97.42%   97.42%           
=======================================
  Files          75       75           
  Lines         350      350           
  Branches       61       61           
=======================================
  Hits          341      341           
  Partials        9        9           

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

@davidlj95 davidlj95 merged commit 96bdb40 into main Aug 13, 2024
34 checks passed
@davidlj95 davidlj95 deleted the stacked/docs-add-reminder-about-values-setting-in-defaults-guide branch August 13, 2024 01:39
Copy link

🎉 This PR is included in version 1.0.0-beta.12 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remind about routing in defaults guide
1 participant