Skip to content

Change hash to digest for consistent terminology across runner logs #1991

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.

Sign up for GitHub

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

Merged
GhadimiR merged 1 commit into from
Mar 12, 2025
Merged

Change hash to digest for consistent terminology across runner logs #1991

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/artifact/src/internal/upload/blob-upload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ export async function uploadZipToBlobStorage(

hashStream.end()
sha256Hash = hashStream.read() as string
Copy link
Member

@Link- Link- Mar 12, 2025

Choose a reason for hiding this comment

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

Wouldn't this apply to the variable names too?

Copy link
Contributor Author

@GhadimiR GhadimiR Mar 12, 2025

Choose a reason for hiding this comment

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

This is a great question that I'm sure we could spend a lot of time thinking about. My view is that we're using a hashing algorithm, so hashStream is the correct term, the hash stream produces a hash, which can also be referred to as a digest, so we could probably go either way on whether or not to rename sha256hash here.

I'd generally lean towards the minimal change as it intuitively makes sense to me that a hashStream would produce a hash, but I'm open to renaming it if you have a more appropriate name for this variable in mind.

core.info(`SHA256 hash of uploaded artifact zip is ${sha256Hash}`)
core.info(`SHA256 digest of uploaded artifact zip is ${sha256Hash}`)

if (uploadByteCount === 0) {
core.warning(
Expand Down
Loading