eclipse-iceoryx / eclipse-iceoryx/iceoryx
Set up CI job to generate `.svg`'s from `.puml`'s
Open
Nobody has claimed this yet.
tooling
- Dominant language
- C++
- Stars
- 2.2k
- Forks
- 492
- Avg merge
- 18h 57m
- Merged PRs (30d)
- 1
Description
Brief feature description
The .svg and the respective .puml often get out of sync.
Detailed information
- Setup a CI job that generates the
.svg's or checks if the.svg's are up to date with the.puml's
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the repository's existing CI configuration and the .puml and .svg files referenced by the issue. Determine how the diagrams are currently generated or checked, then make the CI job detect when generated SVGs are out of date. Done means CI reliably generates the SVGs or fails when they do not match their PUML sources.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, devops
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100