Title: Speeding up the Docs / Docs CI job · Issue #459 · python/core-workflow · GitHub
Open Graph Title: Speeding up the Docs / Docs CI job · Issue #459 · python/core-workflow
X Title: Speeding up the Docs / Docs CI job · Issue #459 · python/core-workflow
Description: The short story I think the Docs CI job can be faster, which would improve the contribution and review experience. Long version In the documentation team meeting we've been talking about a few workflow improvements. The Docs / Docs CI jo...
Open Graph Description: The short story I think the Docs CI job can be faster, which would improve the contribution and review experience. Long version In the documentation team meeting we've been talking about a few work...
X Description: The short story I think the Docs CI job can be faster, which would improve the contribution and review experience. Long version In the documentation team meeting we've been talking about a few ...
Opengraph URL: https://github.com/python/core-workflow/issues/459
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Speeding up the Docs / Docs CI job","articleBody":"# The short story\r\n\r\nI think the Docs CI job can be faster, which would improve the contribution and review experience.\r\n\r\n# Long version\r\n\r\nIn the documentation team meeting we've been talking about a few workflow improvements. The [Docs / Docs CI job](https://github.com/python/cpython/actions/workflows/doc.yml) is quite slow, taking around 15-20 minutes. From some quick testing, it seems this is largely due to that we use Python from HEAD and build Python in the job[^1], rather than a build with optimisation etc. Tests of my speed-up patch reduce the core docs job to ~3m15s[^2].\r\n\r\nAs a reviewer, a green tick is a quick signal that the syntax of the documentation is probably correct, and I don't need to be as thorough, whereas if the build fails I can look in the logs and point out the error and a potential fix to the proponenet of the PR.\r\n\r\nI would suggest moving to `actions/setup-python` for the Docs job, but I don't know if there's been prior discussion[^3] on this that I haven't been able to find, or if there are other reasons it makes sense to trade off speed for building Python from HEAD.\r\n\r\nA\r\n\r\n[^1]: https://github.com/python/cpython/actions/workflows/doc.yml\r\n[^2]: [Patch](https://github.com/AA-Turner/cpython/commit/0ebc3933c27f6c2c4cbd9ad164519591234ea909), [Run 1](https://github.com/AA-Turner/cpython/actions/runs/2453898925), [Run 2](https://github.com/AA-Turner/cpython/actions/runs/2453918261), [Run 3](https://github.com/AA-Turner/cpython/actions/runs/2453977246).\r\n[^3]: #435 discusses not building Python, but in the context of reusing another build from HEAD rather than an optimised version.\r\n","author":{"url":"https://github.com/AA-Turner","@type":"Person","name":"AA-Turner"},"datePublished":"2022-06-07T10:40:36.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":7},"url":"https://github.com/459/core-workflow/issues/459"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:98c1b525-d507-a7d5-a4e8-b81046839a85 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | C4B6:9445B:B3BCD1:F97F56:696A8840 |
| html-safe-nonce | 3a533bce23e96648cbb233c16b681fb050dcae60eb0e51100d4c09f5353ed90c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDNEI2Ojk0NDVCOkIzQkNEMTpGOTdGNTY6Njk2QTg4NDAiLCJ2aXNpdG9yX2lkIjoiMTcwMjc3NTQzODc5MTMxMzQ3MiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 4cee269bedd73b1bdd9bac85df65a81d1c220e98b0e29853552a94071fedace7 |
| hovercard-subject-tag | issue:1263088768 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/core-workflow/459/issue_layout |
| twitter:image | https://opengraph.githubassets.com/058b4de2d57c1a03eb747c293e31a62704c1be1e38c67e77876db30f339af300/python/core-workflow/issues/459 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/058b4de2d57c1a03eb747c293e31a62704c1be1e38c67e77876db30f339af300/python/core-workflow/issues/459 |
| og:image:alt | The short story I think the Docs CI job can be faster, which would improve the contribution and review experience. Long version In the documentation team meeting we've been talking about a few work... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | AA-Turner |
| hostname | github.com |
| expected-hostname | github.com |
| None | d2aa6dedd7d97fa651b17c40401f2605f309df5ca5fb659bf0554cf34f1de825 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/core-workflow git https://github.com/python/core-workflow.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 76080865 |
| octolytics-dimension-repository_nwo | python/core-workflow |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 76080865 |
| octolytics-dimension-repository_network_root_nwo | python/core-workflow |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | c1dbca8981c5e3d6a69bce2f1d289e732b86241d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width