Skip to content

Commit 744b6ef

Browse files
authored
Add checksum for latest artifact to metadata file (#116)
*Issue #, if available:* Same change as this [PR](aws-observability/aws-otel-python-instrumentation#289) Example: [Release Note](https://github.com/harrryr/aws-otel-js-instrumentation/releases/tag/v) *Testing* Workflow run: https://github.com/harrryr/aws-otel-js-instrumentation/actions/runs/12384515024 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.
1 parent c74a2af commit 744b6ef

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

.github/workflows/release-build.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ env:
1414
RELEASE_PRIVATE_REPOSITORY: 020628701572.dkr.ecr.us-west-2.amazonaws.com/adot-autoinstrumentation-node
1515
RELEASE_PRIVATE_REGISTRY: 020628701572.dkr.ecr.us-west-2.amazonaws.com
1616
PACKAGE_NAME: aws-distro-opentelemetry-node-autoinstrumentation
17+
ARTIFACT_NAME: aws-aws-distro-opentelemetry-node-autoinstrumentation-${{ github.event.inputs.version }}.tgz
1718

1819
permissions:
1920
id-token: write
@@ -86,6 +87,11 @@ jobs:
8687
tags: |
8788
${{ env.RELEASE_PRIVATE_REPOSITORY }}:v${{ github.event.inputs.version }}
8889
90+
- name: Get SHA256 checksum of release artifact
91+
id: get_sha256
92+
run: |
93+
shasum -a 256 aws-distro-opentelemetry-node-autoinstrumentation/${{ env.ARTIFACT_NAME }} | sed "s|aws-distro-opentelemetry-node-autoinstrumentation/||" > ${{ env.ARTIFACT_NAME }}.sha256
94+
8995
# Publish to GitHub releases
9096
- name: Create GH release
9197
id: create_release
@@ -96,7 +102,8 @@ jobs:
96102
--title "Release v${{ github.event.inputs.version }}" \
97103
--draft \
98104
"v${{ github.event.inputs.version }}" \
99-
aws-distro-opentelemetry-node-autoinstrumentation/aws-aws-distro-opentelemetry-node-autoinstrumentation-${{ github.event.inputs.version }}.tgz
105+
aws-distro-opentelemetry-node-autoinstrumentation/${{ env.ARTIFACT_NAME }} \
106+
${{ env.ARTIFACT_NAME }}.sha256
100107
101108
# Publish to npm
102109
- name: Publish to npm

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,9 @@ This project ensures compatibility with the following supported NodeJS versions:
4444
### Note on Amazon CloudWatch Application Signals
4545

4646
[Amazon CloudWatch Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html) components are designed to seamlessly work with all library instrumentations offered by [OpenTelemetry NodeJS auto-instrumentation](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/metapackages/auto-instrumentations-node/README.md). While upstream OpenTelemetry NodeJS instrumentations are in beta, Application Signals components are stable, production ready and have also been tested for popular libraries/frameworks such as `ExpressJS, AWS SDK for JavaScript V3, and others`. We will prioritize backward compatibility for Application Signals components, striving to ensure that they remain functional even in the face of potential breaking changes introduced by OpenTelemetry upstream libraries. Please [raise an issue](https://github.com/aws-observability/aws-otel-js-instrumentation/blob/main/CONTRIBUTING.md#reporting-bugsfeature-requests) if you notice Application Signals doesn't work for a particular OpenTelemetry supported library.
47+
48+
## Checksum Verification
49+
50+
Artifacts released will include a `.sha256` file for checksum verification starting from v0.4.0
51+
To verify, run the command `shasum -a 256 -c <artifact_name>.sha256`
52+
It should return the output `<artifact_name>: OK` if the validation is successful

0 commit comments

Comments
 (0)