Replace dependency on canonical-rails with tag helper
#386
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In a subsequent commit, we want to replace the canonical tag helper. So having a record of the current behaviour will help us safely re-implement the functionality. We changed the spec type to `:feature` because there seems to be a database persistence issue when running `:system` tests headfully. (i.e. `ActiveRecord::RecordNotFound` errors for everything!) Seems like a configuration problem. Co-authored-by: benjamin wil <[email protected]>
This replaces the `canonical_tag` helper from `canonical-rails`. This adds simple canonical tag generation, without all the options the gem provides, but in a helper that can be customized by application developers. This would allow us to remove the `canonical-rails` gem as a dependency going forward. Co-authored-by: Benjamin Willems <[email protected]>
Now that we have introduced the `simple_canonical_tag` helper in the previous commit, this is no longer used and needed. Co-authored-by: Andrew Stewart <[email protected]> Co-authored-by: Benjamin Willems <[email protected]>
jarednorman
approved these changes
Nov 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This change removes the dependency on the
canonical-railsgem bycanonical-railsConsidering we are not using some of the features provided by the gem, we decied
to reimplmented the feautres we are using in a simple tag helper. This will
handle the way the starter frontend currently uses the canonical tag helper,
but for storefronts that have more complex requirements, they can add the gem
as a dependency and continue using that.
Upgrade Notes
Usage before upgrading
after upgrading
Checklist
Check out our PR guidelines for more details.
The following are mandatory for all PRs:
The following are not always needed: