From 2f62d85e2fee2a7b7a4168441ad7e64f5f7bd363 Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Tue, 1 Oct 2024 17:44:13 +0530 Subject: [PATCH] Add some docs suggestions from code review Co-Authored-By: Stefan van der Walt <45071+stefanv@users.noreply.github.com> --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2366b61..48e029b 100644 --- a/README.md +++ b/README.md @@ -38,25 +38,23 @@ jobs: uses: scientific-python/upload-nightly-action/remove-wheels@cantknowhashyet # 0.6.0 with: n_latest_uploads: ${{ env.N_LATEST_UPLOADS }} + anaconda_nightly_upload_organization: "your-organization" anaconda_nightly_upload_token: ${{secrets.UPLOAD_TOKEN}} ``` Which will remove all but the `n_latest_uploads` latest uploads from the channel. This is useful to avoid hosting outdated development versions, as well as to clean up space. -The channel to remove wheels from is set to the ``scientific-python-nightly-wheels`` channel -by default. If you are using this channel, please note that this repository will automatically -clean up old artifacts for you. +Note that the ``scientific-python-nightly-wheels`` channel, specifically, already removes +old artifacts daily. The `remove-wheels` action is, therefore, intended for use with +other channels. -If you do not wish to have this automated cleanup, please open an issue on this repository -to be added to the list of packages exempt from it. The current ones are named in -`packages-ignore-from-cleanup.txt`. +If you do not wish to have this automated cleanup, please [open an issue](https://github.com/scientific-python/upload-nightly-action/) +to be added to the list of packages exempt from it. The current ones are named in +[`packages-ignore-from-cleanup.txt`](packages-ignore-from-cleanup.txt). Please refer to the [artifact cleanup policy][] for more information. -To remove wheels from a different channel, set the ``anaconda_nightly_upload_organization`` -variable to the desired organization. - ## Updating the actions You can [use Dependabot to keep the GitHub Action up to date][], @@ -80,7 +78,7 @@ then generate a token at `https://anaconda.org//settin with permissions to _Allow write access to the API site_ and _Allow uploads to Standard Python repositories_, and add the token as a secret to your GitHub repository. -## Using a different channel other than ``scientific-python-nightly-wheels`` +## Using a channel other than ``scientific-python-nightly-wheels`` This Github Action can upload your nightly builds to a different channel. To do so, define the `anaconda_nightly_upload_organization` variable. Furthermore,