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

Get Sha256 Checksum for Release Artifacts #289

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

harrryr
Copy link
Contributor

@harrryr harrryr commented Nov 1, 2024

Issue #, if available:
We want to provide the checksum of release artifact to customers.

Description of changes:
When new artifact is released through release_build.yml, get the sha256 checksum of the artifact then attach it to the release note as a .sha256 file

Example: Release Note

Testing
Workflow run: https://github.com/harrryr/aws-otel-python-instrumentation/actions/runs/12384286607
Verified that the .sha256 has the correct content and running shasum -a 256 -c <artifact_name>.sha256 returns the output <artifact_name>: OK

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

majanjua-amzn
majanjua-amzn previously approved these changes Nov 8, 2024
@srprash
Copy link
Contributor

srprash commented Nov 11, 2024

A few questions:

  • Where and how will generated checksum be used?
  • There's already a version.py where the current released version is tracked (with a .dev0 suffix. Why can't we reuse that instead of creating a new file?

Happy to sync up on this.

@harrryr harrryr force-pushed the add-checksum branch 7 times, most recently from c7193c8 to 32d4fec Compare December 8, 2024 23:40
@harrryr harrryr changed the title Add checksum for wheel artifact and also add version.txt to keep trac… Add checksum for latest artifact to metadata file Dec 8, 2024
@harrryr harrryr force-pushed the add-checksum branch 4 times, most recently from 6f0311d to 82bc923 Compare December 16, 2024 13:12
@harrryr harrryr changed the title Add checksum for latest artifact to metadata file Get Sha256 Checksum for Release Artifacts Dec 16, 2024
@harrryr harrryr force-pushed the add-checksum branch 3 times, most recently from fd7498e to bd4d094 Compare December 16, 2024 20:41
srprash
srprash previously approved these changes Dec 17, 2024
majanjua-amzn
majanjua-amzn previously approved these changes Dec 17, 2024
@harrryr harrryr force-pushed the add-checksum branch 2 times, most recently from 734a8ec to 2146f09 Compare December 17, 2024 22:19
majanjua-amzn
majanjua-amzn previously approved these changes Dec 17, 2024
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
filename="aws_opentelemetry_distro-${{ github.event.inputs.version }}-py3-none-any.whl"
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: filename is used in more than one place, could be worth setting it to an environment variable for reuse to avoid any mistakes in the future

Copy link
Contributor

@srprash srprash left a comment

Choose a reason for hiding this comment

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

Non-blocking: I would also like to see steps somewhere on how can the checksum file be used. Include a simple command example in the readme?

.github/workflows/release_build.yml Outdated Show resolved Hide resolved
.github/workflows/release_build.yml Outdated Show resolved Hide resolved
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.

3 participants