Add a description about document location stored in CircleCI artifact.

Thanks to #1008, documents of the submitted PRs are automatically built in CircleCI jobs and are stored in the artifact. But, some developers say that they cannot access the artifact tabs.

So, how about documenting the URL to the built document? For example, a URL of the document in the artifact is as follows;

https://34609-122299416-gh.circle-artifacts.com/0/docs/build/html/index.html

Here, 34609 matched with the CircleCI’s job ID. So, I think the document can be accessed with the following URL format and the job ID.

https://{ciecleci-job-id}-122299416-gh.circle-artifacts.com/0/docs/build/html/index.html

It would be more helpful if we add a bot that shows the document URLs to the PRs automatically, but it may be overengineering.

[harupy]

@toshihikoyanase You’re right. I’ll use https://github.com/larsoner/circleci-artifacts-redirector-action.

[harupy]

@toshihikoyanase

It would be more helpful if we add a bot that shows the document URLs to the PRs automatically, but it may be overengineering.

This GitHub Action automatically creates a link to the doc as a commit status.

https://github.com/larsoner/circleci-artifacts-redirector-action

I tried this aciton on my repo (https://github.com/harupy/kernel-profiler/pull/57):