Skip to content

Conversation

dkropachev
Copy link
Collaborator

@dkropachev dkropachev commented Sep 26, 2025

Pre-review checklist

  1. Rename workflow files from .yaml to .yml.
  2. Lock and pull python and poetry version from docs/pyproject.toml.
  3. Adds cache to the workflows.
  4. Changes triggering of the workflows.
  5. Small formatting changes.
  6. Don't trigger integration test workflow on docs changes.
  7. Update docs dependencies.
  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • I added relevant tests for new features and bug fixes.
  • All commits compile, pass static checks and pass test.
  • PR description sums up the changes and reasons why they should be introduced.
  • I have provided docstrings for the public items that I want to introduce.
  • I have adjusted the documentation in ./docs/source/.
  • I added appropriate Fixes: annotations to PR description.

Currently they are .yaml while rest of the workflows are .yml.
Let's set it inline with the rest.
@dkropachev dkropachev self-assigned this Sep 26, 2025
@dkropachev dkropachev force-pushed the dk/set-docs-workflows-in-order branch from f83c592 to c9a30ad Compare September 26, 2025 14:37
1. Trigger docs PR check on push to master and on PR events when it
   contains relevant changes
2. Include workflow files into triggering conditions
`actions/setup-python` poetry cache feature requires poetry to be installed beforehand.
It makes use of it extremely awkward.
That is why `action/cache` is used istead.
@dkropachev dkropachev force-pushed the dk/set-docs-workflows-in-order branch 2 times, most recently from 8e22810 to 9cb5785 Compare September 26, 2025 19:55
In order make docs build reproducible we need to lock poetry version.
It will also help with pip cache invalidation on the pipeline, hash will
be calculated from `docs/pyproject.toml`.
Does two things:
1. Lock poetry version in `docs/pyproject.toml`
2. Pull version from `docs/pyproject.toml` in `Makefile`
@dkropachev dkropachev force-pushed the dk/set-docs-workflows-in-order branch from 9cb5785 to 370c01a Compare September 26, 2025 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants