Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Populate release as part of the Step 1: Prep Release workflow? #552

Open
jtpio opened this issue Feb 7, 2024 · 3 comments
Open

Populate release as part of the Step 1: Prep Release workflow? #552

jtpio opened this issue Feb 7, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@jtpio
Copy link
Member

jtpio commented Feb 7, 2024

Problem

Running the Step 1: Prep Release is a good way to check the version is correctly bumped, and the changelog correctly created.

However this workflow does not populate the draft GitHub release with the built artifacts (wheel, sdist, npm tarballs), as this is done as part of the populate-release step in the Step 2: Publish Release workflow.

Maintainers might sometimes want to make sure the built assets are correct, and perform some manual checks.

Proposed Solution

This likely does not require any change to the releaser core functionality. Maybe just moving this step:

- name: Populate Release
id: populate-release
uses: jupyter-server/jupyter_releaser/.github/actions/populate-release@v2
with:
token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
branch: ${{ github.event.inputs.branch }}
release_url: ${{ github.event.inputs.release_url }}
steps_to_skip: ${{ github.event.inputs.steps_to_skip }}

To this workflow: https://github.com/jupyter-server/jupyter_releaser/blob/main/example-workflows/prep-release.yml

I guess one could try that on a test repo first to see if the whole flow would still work fine.

Additional context

cc @martinRenou who I think was mentioning this after using the python_packages configuration of the releaser for https://github.com/voila-dashboards/voici

@jtpio jtpio added the enhancement New feature or request label Feb 7, 2024
@blink1073
Copy link
Contributor

Yeah, that should work, without any changes to core.

@jtpio
Copy link
Member Author

jtpio commented Feb 23, 2024

Maybe one drawback of this approach if that the release commit is pushed during the populate-release step.

Which means that if the maintainer wants to delete the draft GitHub release, they would also have to revert that commit too.

@blink1073
Copy link
Contributor

Yeah, I don't see a way around that, since the assets are tied to the version bump commit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants