Vendor sherlodoc as a submodule and run the driver in CI #1207
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
Closed
Checked-out to branch odoc3_compat of https://github.com/Julow/sherlodoc
The driver runs on Base. This will also test that sherlodoc is co-installable with odoc.
Julow
force-pushed
the
module-sherlodoc
branch
from
6d7ee97 to
1a48b36
Compare
|
Any idea why the lint-doc ci is failing? It seems to not find sherlodoc's dependencies... |
|
Also, it would be nice to add a small section on sherlodoc/git submodules in "CONTRIBUTING.md". Just a cheatsheet on how it would work to make some modifications here, push them to a PR on sherlodoc, pull sherlodoc's changes. |
|
Closing due to the CI problems. |
Merged
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.
This vendors Sherlodoc as a submodule to make running the driver easier locally and in CI.
This allows the CI to check that the driver runs without errors and that sherlodoc continues to build.
Currently, it's checked out to EmileTrotignon/sherlodoc#1. It's expected that the remote and branch of the submodule is changed often.
When testing the driver, make sure to have sherlodoc in the workspace with
git submodule update --init.