Bring in support for mermaid and move pinning forward #4151
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
To get mermaide support working I had to do upgrades. I've updated our pins and documented how they're used as well as how to update them too. This will allow us to do integrated mermaid sequence diagrams as well as flow diagrams instead of committing images of them.
tfoote
changed the title
tfoote
added
the
backport-all
Co-authored-by: Tomoya Fujita <[email protected]> Signed-off-by: Tully Foote <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]> Signed-off-by: Tully Foote <[email protected]>
fujitatomoya
approved these changes
Jan 31, 2024
.gitignore
Outdated
| @@ -3,3 +3,4 @@ plugins/__pycache__ | |||
| _build/ | |||
| .idea/ | |||
| .vscode/ | |||
| __pycache__/ | |||
There was a problem hiding this comment.
Nit: I think we can remove line 2 since this ignores __pychache__ folders at any level?
|
When this lands can one of you ping me? I think we should make an announcement so the broader community knows about it. |
Signed-off-by: Tully Foote <[email protected]>
Signed-off-by: Tully Foote <[email protected]>
mergify bot
pushed a commit
that referenced
this pull request
Feb 5, 2024
* Add mermaid support and update pinned version To get mermaid support working I had to do upgrades. I've updated our pins and documented how they're used as well as how to update them too. This will allow us to do integrated mermaid sequence diagrams as well as flow diagrams instead of committing images of them. * clean up docker installation to focus on pip version pinning * Match folders in ignore too Signed-off-by: Tully Foote <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]> (cherry picked from commit c569b50)
mergify bot
pushed a commit
that referenced
this pull request
Feb 5, 2024
* Add mermaid support and update pinned version To get mermaid support working I had to do upgrades. I've updated our pins and documented how they're used as well as how to update them too. This will allow us to do integrated mermaid sequence diagrams as well as flow diagrams instead of committing images of them. * clean up docker installation to focus on pip version pinning * Match folders in ignore too Signed-off-by: Tully Foote <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]> (cherry picked from commit c569b50)
This was referenced Feb 5, 2024
tfoote
added a commit
that referenced
this pull request
Feb 5, 2024
* Add mermaid support and update pinned version To get mermaid support working I had to do upgrades. I've updated our pins and documented how they're used as well as how to update them too. This will allow us to do integrated mermaid sequence diagrams as well as flow diagrams instead of committing images of them. * clean up docker installation to focus on pip version pinning * Match folders in ignore too Signed-off-by: Tully Foote <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]> (cherry picked from commit c569b50) Co-authored-by: Tully Foote <[email protected]>
tfoote
added a commit
that referenced
this pull request
Feb 5, 2024
* Add mermaid support and update pinned version To get mermaid support working I had to do upgrades. I've updated our pins and documented how they're used as well as how to update them too. This will allow us to do integrated mermaid sequence diagrams as well as flow diagrams instead of committing images of them. * clean up docker installation to focus on pip version pinning * Match folders in ignore too Signed-off-by: Tully Foote <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]> (cherry picked from commit c569b50) Co-authored-by: Tully Foote <[email protected]>
|
Quick questions:
|
|
The needed extras are in the requirements.txt so if you follow the installation instructions you get it. Existing installations will need to rerun the installer. An example using it: gonzodepedro@d580364#diff-c9bf592e9b9e4321631795943475e03abda9bb1bd2634b831482f53355f370dcR232 It will be rebased and open as PR on top of this shortly, but it's not landed yet as this was pending. |
|
This pull request has been mentioned on ROS Discourse. There might be relevant details there: https://discourse.ros.org/t/ros-news-for-the-week-of-february-12th-2024/36135/1 |
|
This pull request has been mentioned on ROS Discourse. There might be relevant details there: |
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.
I'm working with @gonzodepedro to bring in sequence diagrams to explain the idl generation. And we got bogged down in trying to get mermaid added to the system.
Without being able to do this we're working on committing the mmd files as well as the images.
We had pinned back everything to match Jammy. I think that pinning everything makes sense, but I think that we should allow rolling forward before Ubuntu does, but we should stick to virtualenv supported versions to not get too far out of date. To that end this is validating and pulling the pins all forward to a pip upgrade. It works for both the local build and the multiversion build on my local machine.
For reference we're working on documentation improvements like this: https://github.com/gonzodepedro/ros2_documentation/pull/1/files#diff-4cfad9479ac6c8d7db3ebcaaa176863bcf74f19ebbb2a101c281d6439e801c12