JanusGraph / JanusGraph/janusgraph
Automate janusgraph-cfg.md generation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 5.8k
- Forks
- 1.2k
- Avg merge
- 13h 53m
- Merged PRs (30d)
- 6
Description
Currently users should execute `mvn --quiet clean install -DskipTests=true -pl janusgraph-doc -am` after they added a new configuration option into JanusGraph. If they don't execute this command they will get Travis CI failure like in #1732 (https://travis-ci.org/JanusGraph/janusgraph/jobs/591029552).
Users may not know about this and it leads to not understanding the problem (why Travis CI fails).
I propose to automatically execute `mvn --quiet clean install -DskipTests=true -pl janusgraph-doc -am` in Travis CI if it fails with error in `janusgraph-cfg.md`. In such case, users don't need to execute `mvn --quiet clean install -DskipTests=true -pl janusgraph-doc -am` and configuration references will be generated automatically when it needs to update configuration references.
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
Start by inspecting the Travis CI configuration and the janusgraph-doc build invoked by `mvn --quiet clean install -DskipTests=true -pl janusgraph-doc -am`. Determine how failures involving `janusgraph-cfg.md` are detected and regenerated. Done means configuration references are updated automatically in the relevant CI case without requiring users to run the command manually.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, ci-cd
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100