Repository navigation
151 lines (138 loc) · 7.24 KB
/
Copy pathPublishOnPyPI.yml
File metadata and controls
151 lines (138 loc) · 7.24 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# Unai Martinez-Corral #
# #
# ==================================================================================================================== #
# Copyright 2020-2026 The pyTooling Authors #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
name: Publish on PyPI
on:
workflow_call:
inputs:
ubuntu_image_version:
description: 'Ubuntu image version.'
required: false
default: '26.04'
type: string
python_version:
description: 'Python version.'
required: false
default: '3.15'
type: string
requirements:
description: 'Python dependencies to be installed through pip.'
required: false
default: 'wheel twine'
type: string
artifact:
description: 'Name of the package artifact.'
required: true
type: string
pypi_upload_url:
description: 'Upload URL of the package registry.'
required: false
default: 'https://upload.pypi.org/legacy/'
type: string
dry_run:
description: 'Validate the packages with twine, but do not upload them to PyPI.'
required: false
default: 'false'
type: string
cleanup:
description: 'Cleanup artifacts afterwards.'
required: false
default: 'true'
type: string
pypi_compliant:
description: "If 'false', refuse to upload (warn on a dry run): the package has direct references."
required: false
default: 'true'
type: string
publish_sdist:
description: "If 'true', publish the source distribution (*.tar.gz). Default changes to 'false' with @r10."
required: false
default: 'true'
type: string
publish_wheel:
description: "If 'true', publish the wheel (*.whl)."
required: false
default: 'true'
type: string
secrets:
PYPI_TOKEN:
description: "Token for pushing releases to PyPI"
required: false
jobs:
PublishOnPyPI:
name: 🚀 Publish to PyPI
runs-on: "ubuntu-${{ inputs.ubuntu_image_version }}"
steps:
- name: 📥 Download artifacts '${{ inputs.artifact }}' from 'Package' job
uses: pyTooling/download-artifact@v8
with:
name: ${{ inputs.artifact }}
path: dist
- name: 🕵️ Check that the package is PyPI-compliant
if: inputs.pypi_compliant == 'false'
run: |
ANSI_LIGHT_RED=$'\x1b[91m'
ANSI_LIGHT_YELLOW=$'\x1b[93m'
ANSI_NOCOLOR=$'\x1b[0m'
message="the package metadata has direct references, which PyPI rejects."
message+=" See the warnings of the 'Package' job."
if [[ "${{ inputs.dry_run }}" == "true" ]]; then
printf -- "${ANSI_LIGHT_YELLOW}The package isn't PyPI-compliant (dry run).${ANSI_NOCOLOR}\n"
printf -- "::warning title=PyPI compliance::A real upload would fail: %s\n" "${message}"
else
printf -- "${ANSI_LIGHT_RED}The package isn't PyPI-compliant.${ANSI_NOCOLOR}\n"
printf -- "::error title=PyPI compliance::Not uploading: %s\n" "${message}"
exit 1
fi
- name: 🐍 Setup Python ${{ inputs.python_version }}
uses: actions/setup-python@v7
with:
python-version: ${{ inputs.python_version }}
- name: ⚙ Install dependencies for packaging and release
run: python -m pip install --disable-pip-version-check ${{ inputs.requirements }}
- name: 🩺 Check Python wheel package instead of publishing it
if: inputs.dry_run == 'true' && inputs.publish_wheel == 'true'
run: twine check dist/*.whl
- name: 🩺 Check Python source package instead of publishing it
if: inputs.dry_run == 'true' && inputs.publish_sdist == 'true'
run: twine check dist/*.tar.gz
- name: ⚠ Nothing selected for publishing
if: inputs.publish_wheel != 'true' && inputs.publish_sdist != 'true'
run: |
printf -- "::warning title=PublishOnPyPI::Nothing published or checked: 'publish_wheel' and 'publish_sdist' are both 'false'.\n"
- name: ⤴ Publish Python wheel package to PyPI
if: inputs.dry_run != 'true' && inputs.publish_wheel == 'true'
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
run: twine upload --repository-url "${{ inputs.pypi_upload_url }}" dist/*.whl
- name: ⤴ Publish Python source package to PyPI
if: inputs.dry_run != 'true' && inputs.publish_sdist == 'true'
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
run: twine upload --repository-url "${{ inputs.pypi_upload_url }}" dist/*.tar.gz
- name: 🗑️ Delete packaging Artifacts
uses: geekyeggo/delete-artifact@v6
if: inputs.cleanup == 'true'
with:
name: ${{ inputs.artifact }}