[LTD-5428] Make CI check routing docs are up to date #2206
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
currycoder
force-pushed
the
LTD-5428-check-routing-docs-in-ci
branch
from
369c14a
to
99daade
Compare
currycoder
changed the title
kevincarrogan
approved these changes
Sep 26, 2024
Tllew
approved these changes
Sep 26, 2024
currycoder
force-pushed
the
LTD-5428-check-routing-docs-in-ci
branch
from
99daade
to
e5936df
Compare
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.
Aim
This change adds a new circle CI job to ensure that the lite_routing documentation is up to date.
This is achieved by generating the docs again in circleci (after bringing up a seeded/migrated app) and checking for differences from what we have in git for lite-routing.
If differences are observed, the check fails with an error message which shows the diff.
PRs for the lite-routing repository will get this check "for free" since the CI for that repository calls through to lite-api's CI pipeline.
NOTE: We should only merge this PR when the companion PR in lite-routing has merged https://github.com/uktrade/lite-routing/pull/268 AND when we are ready to update the lite-routing submodule sha.
LTD-5428