xcookie.builders.common_ci module

Common subroutines for consistency between gitlab-ci / github actions / etc…

xcookie.builders.common_ci.make_typecheck_parts(self)

Return a list of shell commands to run type checkers.

By default this will run both mypy and ty (in that order). The returned value is a list of command strings so callers can adapt it to either GitHub Actions (run string) or GitLab CI (script list).

xcookie.builders.common_ci.make_build_sdist_parts(self, wheelhouse_dpath='wheelhouse')

xcookie.builders.common_ci.make_build_wheel_parts(self, wheelhouse_dpath='wheelhouse')

xcookie.builders.common_ci.make_install_and_test_wheel_parts(self, wheelhouse_dpath, special_install_lines, workspace_dname, custom_before_test_lines=[], custom_after_test_commands=[])

Builds the YAML common between github actions and gitlab CI to install and tests python packages.

References

https://stackoverflow.com/questions/42019184/python-how-can-i-get-the-version-number-from-a-whl-file

xcookie.builders.common_ci.get_supported_platform_info(self)

CommandLine

xdoctest -m /home/joncrall/code/xcookie/xcookie/builders/common_ci.py get_supported_platform_info
xdoctest -m xcookie.builders.common_ci get_supported_platform_info

Example

>>> from xcookie.builders.github_actions import *  # NOQA
>>> from xcookie.builders.common_ci import *  # NOQA
>>> from xcookie.main import XCookieConfig
>>> from xcookie.main import TemplateApplier
>>> config = XCookieConfig(tags=['purepy'], remote_group='Org', repo_name='Repo')
>>> self = TemplateApplier(config)
>>> supported_platform_info = get_supported_platform_info(self)
>>> import ubelt as ub
>>> print(f'supported_platform_info = {ub.urepr(supported_platform_info, nl=2)}')