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

Publish to TestPyPi on PR and release #592

Merged
merged 7 commits into from
Jan 18, 2023

Conversation

i-oden
Copy link
Member

@i-oden i-oden commented Jan 10, 2023

Before submitting the PR

  • Fill in and tick fields
  • Remove all rows that are not relevant for the current PR
    • Revelant option missing? Add it as an item and add a PR comment informing that the new option should be included into this template.

All relevant items should be ticked before the PR is merged

Description

  • Summary of the changes and the related issue:

In order to debug and prevent potential issues during releases, we should also 1. publish the CLI to TestPyPi on pr to dev and on release before real publishing, 2. make sure that the hashes are correct. Possible that we also should recommend verifying the hashes after installation.

The print_hash: true part in tells the action to show the hashes of what will be published. Easily verified manually by checking on PyPi. If something happens though and there's an error, the publishing will not occur.

  • Fixes an issue in GitHub / Jira:
    • Yes: DDS-1443 and DDS-1415

Type of change

  • Workflow

Checklist:

General

  • Changelog: New row added. Not needed when PR includes only tests.

Repository / Releases

  • Rebase / update of branch done

Checks

  • CodeQL passes
  • Formatting: Black & Prettier checks pass
  • Tests
    • The tests pass
  • Trivy:
    • There are no new security alerts

@i-oden i-oden self-assigned this Jan 10, 2023
@codecov
Copy link

codecov bot commented Jan 10, 2023

Codecov Report

Merging #592 (12b803a) into dev (8931db6) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #592   +/-   ##
=======================================
  Coverage   46.68%   46.68%           
=======================================
  Files          31       31           
  Lines        2787     2787           
=======================================
  Hits         1301     1301           
  Misses       1486     1486           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@i-oden i-oden requested a review from valyo January 10, 2023 07:54
@i-oden i-oden changed the title Print hash when publishing CLI package Publish to TestPyPi on PR and release Jan 10, 2023
Copy link
Member

@valyo valyo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
I don't completely understand the hashes part but you can probably explain it to me additionally

@i-oden
Copy link
Member Author

i-oden commented Jan 18, 2023

Looks good. I don't completely understand the hashes part but you can probably explain it to me additionally

Before publishing to PyPi the action generates a checksum. These hashes are then available on PyPi, in the "Download" section, in case someone wants to verify them. This "print_hashes" part basically just prints these hashes out here on GitHub so that we could technically check that these hashes are identical to the ones on PyPi and we could possibly add this information to the documentation somehow (not sure though), to recommend that all users verify the integrity of the package. As a precaution and threat mitigation.

@i-oden i-oden merged commit 3165870 into dev Jan 18, 2023
@i-oden i-oden deleted the DDS-1443-generate-signatures-for-releases branch January 18, 2023 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants