Skip to content
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

update RTD config, move doc deps into their own group, update dev group #2381

Merged
merged 5 commits into from
Jun 26, 2024

Conversation

ITProKyle
Copy link
Collaborator

@ITProKyle ITProKyle commented Jun 21, 2024

What Changed

Added

  • (actions) added info job to the CI/CD workflow
    • uses github context to provide outputs that can be used to simplify conditionally skipping jobs
    • these outputs replace and improve some of the conditions used by the test-functional and deploy-test-infrastructure jobs as these are unable to run when a PR is opened from a fork because they require secrets

Changed

  • (pyproject.toml) renamed [tool.poetry.dev-dependencies] table to [tool.poetry.group.dev.dependencies]
    • new notation added in poetry >= 1.2.0 (source)
    • old notation will be deprecated in a future release
  • (pyproject.toml) moved documentation dependencies out of the main dependency group into the docs dependency group ([tool.poetry.group.docs.dependencies] table)
    • updated Makefile accordingly to remove --extras flag
  • (pyproject.toml) moved boto3-stubs & mypy-boto3 out of the dev dependency group into the types dependency group to better reflect what they are being installed for
  • (.readthedocs.yml) updated config to use the documented method to Install dependencies with Poetry
    • python version used to build documentation was also bumped when updating the config
  • (actions) removed uses of --extras docs
  • (actions) the Spell Check workflow will not trigger for pull requests and pushes to the master branch rather than only for pushes to all branches
    • this mirrors the triggering events of the CI/CD workflow
    • could be the cause of the PR becoming stuck waiting for the Spell Check workflow to run/report status as this PR is opened from a fork which does not run actions by default

@github-actions github-actions bot added documentation Improvements or additions to documentation poetry Update to Poetry configuration python Update to Python code labels Jun 21, 2024
@ITProKyle ITProKyle marked this pull request as ready for review June 21, 2024 15:41
Copy link

@alexander-kogan alexander-kogan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ITProKyle
Copy link
Collaborator Author

codecov failure is a known bug in the current version of the action when creating a PR from a fork - codecov/codecov-action#1487

Copy link

codecov bot commented Jun 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.18%. Comparing base (65d6882) to head (72a3712).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2381   +/-   ##
=======================================
  Coverage   90.18%   90.18%           
=======================================
  Files         247      247           
  Lines       15677    15677           
=======================================
  Hits        14138    14138           
  Misses       1539     1539           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 65d6882...72a3712. Read the comment docs.

@mbordash2 mbordash2 self-requested a review June 25, 2024 17:55
this new job produces outputs that can be used by other jobs to determine if they should run or not making it easier to skip jobs on/from forks that can't run on/from forks.
the PR for this change is stuck waiting for the "Spell Check" workflow to run. this could be caused by the trigger only being defined for pushed events and this being from a fork where actions don't run.
@mbordash2 mbordash2 merged commit 6e44fda into rackspace:master Jun 26, 2024
22 checks passed
@ITProKyle ITProKyle deleted the docs/update-rtd-config branch August 8, 2024 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation poetry Update to Poetry configuration python Update to Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants