@@ -58,6 +58,28 @@ This GitHub Action [has nothing to do with _building package
58
58
distributions_]. Users are responsible for preparing dists for upload
59
59
by putting them into the `dist/` folder prior to running this Action.
60
60
61
+ > **IMPORTANT**: Since this GitHub Action is docker-based, it can only
62
+ > be used from within GNU/Linux based jobs in GitHub Actions CI/CD
63
+ > workflows. This is by design and is unlikely to change due to a number
64
+ > of considerations we rely on.
65
+ >
66
+ > This should not stop one from publishing platform-specific
67
+ > distribution packages, though. It is strongly advised to separate jobs
68
+ > for building the OS-specific wheels from the publish job. This allows
69
+ > one to (1) test exactly the same artifacts that are about to be
70
+ > uploaded to PyPI, (2) prevent parallel unsynchronized jobs from
71
+ > publishing only part of the dists asynchronously (in case when part of
72
+ > the jobs fail and others succeed ending up with an incomplete release
73
+ > on PyPI) and (3) make an atomic upload to PyPI (when part of the dists
74
+ > appear on PyPI, installers like pip will use that version for the
75
+ > dependency resolution but this may cause some environments to use
76
+ > sdists while the wheels for their runtime is not yet available).
77
+ >
78
+ > To implement this sort of orchestration, please use
79
+ > `actions/upload-artifact` and `actions/download-artifact` actions for
80
+ > sharing the built dists across stages and jobs. Then, use the `needs`
81
+ > setting to order the build, test and publish stages.
82
+
61
83
62
84
# # Advanced release management
63
85
0 commit comments