Skip to content

Commit d063672

Browse files
mihaimaruseaclwasser
authored andcommitted
Fix a few more typos, fix warnings
Signed-off-by: Mihai Maruseac <[email protected]>
1 parent fd3c99e commit d063672

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

tutorials/trusted-publishing.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ to publish a package from your project to PyPI.
4141
To get started, create a file named `release.yaml` under the `.github/workflows`
4242
directory of your project.
4343

44-
:::{admonition}
44+
:::{admonition} Naming the workflow
4545
:class: tip
4646

4747
The name of the worklow is not relevant, but `release.yaml` is the most
@@ -65,6 +65,8 @@ this GitHub Action on the "Actions" tab in the GitHub repository.
6565
6666
:::{figure-md} github-actions-release-workflows-summary
6767
<img src="../images/tutorials/github-actions-release-workflows-summary.png" alt="Graphic showing an example of a configured workflow for the release. On the top, in the red box labeled "1" you see the "Actions" tab of the GitHub repository. On the left, in the red box labeled "2" you can see the name of the workflow, as configured in this step. Finally, in the center, in the red box labeled "3" you can see several runs of the workflow, for the "1.0" and "1.0.1" releases of the package." width="700px">
68+
69+
This image shows an example of a configured workflow for the release. On the top, in the red box labeled "1" you see the "Actions" tab of the GitHub repository. On the left, in the red box labeled "2" you can see the name of the workflow, as configured in this step. Finally, in the center, in the red box labeled "3" you can see several runs of the workflow, for the "1.0" and "1.0.1" releases of the package.
6870
:::
6971
7072
### Step 2: Add triggers to the workflow
@@ -159,7 +161,7 @@ the following to the `release.yaml` file:
159161
retention-days: 1
160162
```
161163

162-
:::{admonition}
164+
:::{admonition} Upload artifacts parameters
163165
:class: tip
164166

165167
We have configured the artifact to be deleted after 1 day. The artifacts storage
@@ -178,13 +180,17 @@ storage.
178180

179181
:::{figure-md} github-actions-release-workflows-run
180182
<img src="../images/tutorials/github-actions-release-workflows-run.png" alt="Graphic showing an example of a release workflow that has just finished running. Each step in the log is matched to one step in the workflow definition." width="700px">
183+
184+
This figure shows an example of a release workflow that has just finished running. Each step in the log is matched to one step in the workflow definition." width
181185
:::
182186

183187
At the bottom of the workflow run page on GitHub you should see a section for
184188
the artifacts produced during runtime and uploaded to this storage area:
185189

186190
:::{figure-md} github-actions-release-workflows-artifacts
187191
<img src="../images/tutorials/github-actions-release-workflows-artifacts.png" alt="Graphic showing an example of an artifact produced by the release workflow." width="700px">
192+
193+
This figure shows the artifact produced by the above release workflow. It is now marked as expired since the workflow ran more than a day ago.
188194
:::
189195

190196
You can download the artifact (before it expires), unzip it and install the
@@ -223,7 +229,7 @@ the previous section:
223229
- uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
224230
```
225231

226-
:::{admonition}
232+
:::{admonition} Make sure to change the URL
227233

228234
Remember to change the `url:` to the URL for your package on PyPI!
229235
:::
@@ -251,7 +257,7 @@ developers created Trusted Publishing. This allows registering publishers on
251257
PyPI and mapping them to the automation workflow that is allowed to publish the
252258
package.
253259

254-
:::{admonition}
260+
:::{admonition} Trusted Publishing outside of GitHub Actions
255261
:class: tip
256262

257263
Trusted Publishing supports other automation platforms, beyond GitHub Actions.
@@ -270,12 +276,17 @@ On the ["Your projects" page on PyPI](https://pypi.org/manage/projects/), click
270276

271277
:::{figure-md} trusted-publishing-your-projects
272278
<img src="../images/tutorials/trusted-publishing-your-projects.png" alt="Graphic showing a screenshot of the "Your projects" page on PyPI. The "Manage" button for one of the projects is highlighted." width="700px">
279+
280+
This image shows several projects. The "Manage" button is highlighted for one of the projects, the one we want to configure trusted publishing for.
273281
:::
274282

275283
Then click "Publishing" in the project's sidebar.
276284

277285
:::{figure-md} trusted-publishing-publishing
278286
<img src="../images/tutorials/trusted-publishing-publishing.png" alt="Graphic showing the management page for one project. The "Publishing" link in the sidebar is highlighted." width="700px">
287+
288+
Once clicking on the "Manage" button we got to the project's page. In the
289+
sidebar, we have the "publishing" option, as highlighted here.
279290
:::
280291

281292
This will take you to the publisher configuration page for the project. Trusted
@@ -293,7 +304,7 @@ the following information:
293304
Once you fill in this form and click "Add" the publisher is configured and can
294305
be used to publish new releases of your package.
295306

296-
:::{admonition} Fully hardeneds GitHub Actions release workflow
307+
:::{admonition} Fully hardened GitHub Actions release workflow
297308

298309
For better security it is recommended to also control the permissions of the
299310
GitHub token used within each job of the workflow. The permissions should be

0 commit comments

Comments
 (0)