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

Enable plugin writers to install packages on the host OS #879

Merged
merged 1 commit into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ The following settings are stored in `template_config.yml`.

docs_test Include a CI build for testing the 'make html' command for sphinx docs.

os_required_packages A list of packages to be installed on the host OS (Ubuntu) in the build
step.

parallel_test_workers Run tests in parallel using `pytest-xdist` with N parallel runners. This
settings specifies N. By default it is 8.

Expand Down
1 change: 1 addition & 0 deletions plugin-template
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ DEFAULT_SETTINGS = {
"latest_release_branch": None,
"lint_requirements": True,
"noissue_marker": "[noissue]",
"os_required_packages": [],
"parallel_test_workers": 8,
"plugin_app_label": None,
"plugin_default_branch": "main",
Expand Down
5 changes: 5 additions & 0 deletions templates/github/.github/workflows/build.yml.j2
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ jobs:
{{ checkout(repository="pulp/pulp-openapi-generator", path="pulp-openapi-generator") | indent(6) }}
{{ setup_python() | indent(6) }}
{{ install_python_deps(["packaging", "twine", "wheel", "mkdocs", "jq"]) | indent(6) }}
{%- if os_required_packages %}
- name: "Install OS packages"
run: |
sudo apt-get install -y {{ os_required_packages|join(' ') }}
{%- endif %}
- name: "Build package"
run: |
python3 setup.py sdist bdist_wheel --python-tag py3
Expand Down
Loading