ci: use launchdarkly publish docs action #332
Conversation
|
This pull request has been linked to Shortcut Story #225790: Update publish docs workflow to use shared action. |
cwaldren-ld
force-pushed
the
cw/sc-225790/publish-docs-use-action
branch
from
bfb9d1b to
4284d7d
Compare
| ./scripts/publish-doc.sh $WORKSPACE | ||
| env: | ||
| WORKSPACE: ${{ inputs.workspace_path }} | ||
| docs_path: ${{ inputs.workspace_path }} |
There was a problem hiding this comment.
I am reasonably sure this should be in a subdirectory. ${{ inputs.workspace_path }}/docs
The output in the doxyfile contains docs and the old script used docs.
There was a problem hiding this comment.
I did that originally (first commit), and it then broke all existing docs links (like from README + LaunchDarkly public docs) when I ran the manual publish workflow.
It might be more correct to not have the docs subdir in the path, but that's what we currently have e.g.
https://launchdarkly.github.io/cpp-sdks/libs/server-sdk/docs/html/
There was a problem hiding this comment.
Not including it means you are publishing all the source into docs which happens to include docs. If you want it in a sub-directory on the output, then put that into the output path as well.
There was a problem hiding this comment.
What it used to, and correctly, looked like:
There was a problem hiding this comment.
So, before we took the $workspace/docs and put them into $workspace/docs.
Currently you are putting $workspace/ which happens to contain docs into $workspace/.
There was a problem hiding this comment.
Is this what you tried?
docs_path: ${{ inputs.workspace_path }}/docs
output_path: ${{ inputs.workspace_path }}/docs
If it doesn't work, then we need to fix a bug in the action.
There was a problem hiding this comment.
Ok, I had only added /docs to the docs_path. That was the problem. Updated both and all is working now (+ I've fixed up the gh-pages branch.)
Updates the publish docs workflow + action to use the launchdarkly shared action.