Rework build caching #843
Merged
Rework build caching #843
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
The following provides a series of corrections and improvements towards this extension tracking outdated pages and managing/tracking publication information to help manage cleanup processes when only subset of pages are updated. Part of the problem with this extension's original implementation is that lack of consideration for Sphinx's documentation cache. In most use cases, the `-E` argument was used/promoted to start with a clean environment to ensure all documents are processed and published. For uses who did not force a clean environment would see unexpected results, mainly when cleanup options were enabled. Specifically, after publishing documentation, a re-publish of new documentation with a subset of changes could make some valid-but-not-updated pages be removed. This commit should bring proper cache management to handle rebuilds and republish events. We now track a hash of the Confluence-specific configuration hash to help immediately flag pages as outdated when these entries are updated. We also now keep track of last page publish identifiers from a previous publication event. This information can be used to unflag pages that are believed to be legacy pages, ensuring up-to-date pages remain on the target Confluence instance. Signed-off-by: James Knight <[email protected]>
With the re-work in managing build cache and managing legacy pages, adding a series of unit tests to verify these capabilities. Signed-off-by: James Knight <[email protected]>
Adding a series of configuration entries to flag an outdated documentation set if these options are changed. These options were not set before, however, navigation changes can require a full republish, especially if other navigation options (e.g. next-prev pages) are enabled. Signed-off-by: James Knight <[email protected]>
Signed-off-by: James Knight <[email protected]>
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.
The following provides a series of corrections and improvements towards this extension tracking outdated pages and managing/tracking publication information to help manage cleanup processes when only subset of pages are updated.
Part of the problem with this extension's original implementation is that lack of consideration for Sphinx's documentation cache. In most use cases, the
-Eargument was used/promoted to start with a clean environment to ensure all documents are processed and published. For uses who did not force a clean environment would see unexpected results, mainly when cleanup options were enabled. Specifically, after publishing documentation, a re-publish of new documentation with a subset of changes could make some valid-but-not-updated pages be removed.This commit should bring proper cache management to handle rebuilds and republish events. We now track a hash of the Confluence-specific configuration hash to help immediately flag pages as outdated when these entries are updated. We also now keep track of last page publish identifiers from a previous publication event. This information can be used to unflag pages that are believed to be legacy pages, ensuring up-to-date pages remain on the target Confluence instance.