-
Notifications
You must be signed in to change notification settings - Fork 2.1k
ci: use circleci to get a preview of the generated documentation #8729
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
we could also save murdock's output. |
I thought of it but the effort was not the same, at least for me. |
Is there still interest in this PR? |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If you want me to ignore this issue, please mark it with the "State: don't stale" label. Thank you for your contributions. |
I've updated the initial goal of this PR to only build the documentation and use Circle CI Artifacts to get a preview of the generated documentation. The bad news is that now it take more than 25 minutes to upload the artifacts to S3 (the storage backend on CircleCI). This is because the doxygen documentation generates a lot of single file and they are copied one by one. |
Are there other backend options? |
I don't think so: https://circleci.com/docs/2.0/artifacts/ |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If you want me to ignore this issue, please mark it with the "State: don't stale" label. Thank you for your contributions. |
still useful, although slow. |
Can we revive this one? As long as |
2dcafe1
to
6371c03
Compare
What needs to be configured to add the status of circle-ci to the PR? |
I think integration of external applications, similar to Travis I guess. If 25 minutes is acceptable before the documentation preview is available, using circleci is useful. Unfortunately, because of the huge amount of single files to upload (+19k), 99% of the time is spent in uploading the artifacts.
|
We could (and probably should), like with Travis make the results non-binding. If for any reason the artefacts are of any interest, the wait time is not much longer as with current Murdock ;-). |
You have some doc on that? |
Could this one help: https://circleci.com/docs/2.0/gh-bb-integration/#section=projects ? |
Can you do a force push to see if it worked? |
Integration seems to work, I see a new circleci item. |
You seem to need to log in (via GitHub) to be able to see the progress. |
So after 27 minutes of copy... the documentation artifacts are available here. And the generated documentation is available at https://2803-44016379-gh.circle-artifacts.com/0/doc/index.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then I say: Let's try this out :-).
Contribution description
This PR is an attempt to move the static-test from travis to circleci. The main ideas behind are:
I tested the solution on my own fork and it works. One can see the results here: https://circleci.com/gh/aabadie/RIOT/8 and the generated documentation here: https://8-44016379-gh.circle-artifacts.com/0/tmp/doc/html/index.html
The main problem I see is the time it takes to upload the artifacts to the final report. The total build time is 9 minutes and the upload takes a bit more than 7 minutes.
Issues/PRs references
None