[Draft] Add workflow for standard library documentation generation #534
Conversation
This file contains hidden or 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
5877dfd to
ee38977
Compare
d0bb06a to
bf8bb0e
Compare
attempt to fix path attempt to fix path 2 install jolie within action debug revert debug
md filetype only support port documentation
fix action script
bf8bb0e to
7b6465f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 PR adds workflow for standard library documentation generation. It includes:
Requirement
New secret:
API_TOKEN_GITHUB=TOKEN # a token with write permission for "Contents" for docs repository, in order to push the generated files.
Workflow description
The workflow runs after Java CI on the main branch is completed, or triggered manually.
It builds Jolie from the commit and runs joliedoc on each library, applying some script to modify content for the Service/module level that is missing information from the joliedoc, and then pushing the generated file to the docs repo. In case of publishing a new library, the action also modifies SUMMARY.md accordingly. The target branch name is based on the Jolie version specified in pom.xml.
Note
In the case of a library that contains several ports, the action will guess the joliedoc generated file from the inputport name, otherwise it will take the first generated file to show on the documentation page.