fix: doc attribute inconsistencies #101
Merged
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
Bumps [github.com/cloudflare/circl](https://github.com/cloudflare/circl) from 1.3.3 to 1.3.7. - [Release notes](https://github.com/cloudflare/circl/releases) - [Commits](cloudflare/circl@v1.3.3...v1.3.7) --- updated-dependencies: - dependency-name: github.com/cloudflare/circl dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]>
Replace the `otherattributemodifier` package with a simpler `ModifyPlan` receiver function for handling attribute changes when other attributes change. Most doc attributes should cause the "revision", "updated_at", "user", and "algolia" attributes to be unknown, since they are updated when changes to a doc are published. This also applies to the 'version' resource. Prior to this, the body's value wasn't tracked properly due to normalization by the ReadMe API. With this update, the `body` attribute tracks the user-provided value while the `body_clean` attribute is the normalized version that gets compared to the API. An additional change adds a second post-apply read of the doc to ensure the stable values from the API are used in the state.
bdwellons
approved these changes
Jan 19, 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.
Replace the
otherattributemodifierpackage with a simplerModifyPlanreceiver function for handling attribute changes when other attributes
change. Most doc attributes should cause the "revision", "updated_at",
"user", and "algolia" attributes to be unknown, since they are updated
when changes to a doc are published. This also applies to the 'version'
resource.
Prior to this, the body's value wasn't tracked properly due to
normalization by the ReadMe API. With this update, the
bodyattributetracks the user-provided value while the
body_cleanattribute is thenormalized version that gets compared to the API.
An additional change adds a second post-apply read of the doc to ensure
the stable values from the API are used in the state.