riseproject-dev / riseproject-dev/python-wheels

Make dry-run publish steps' labeling more explicit

Open Beginner friendly
#208 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue infrastructure
Dominant language
Python
Stars
0
Forks
0
Avg merge
16h 14m
Merged PRs (30d)
952

Description

From https://github.com/riseproject-dev/python-wheels/pull/204#discussion_r3734442848:

not strictly related to this PR, but what about having a ./.github/workflows/deploy.yml workflow that would contains this to avoid copying it in each individual workflow?

The other benefit is that inside this file we could do something like:

  • name: Deploy${{ github.ref != 'refs/heads/main' && ' (dry run)' || '' }}
    uses: ./.github/actions/deploy
    with:
    dry-run: ${{ github.ref != 'refs/heads/main' }}

So the name of the job will actually contain "(dry run)" . Right now, we have the impression that the publish job succeeded and correctly uploaded file on the registry


Further deploy changes probably aren't worth the effort, but taking Julien's suggestion to make the dry-run labeling more explicit would be helpful for our PRs.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review .github/workflows/deploy.yml and .github/actions/deploy, along with the workflows that currently repeat the deploy steps. Update the publish-step labeling so dry runs are visibly marked, then run the affected GitHub Actions workflow to confirm the job name communicates that no real upload occurred.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, release
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
73/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.