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

chore: add release-please automation #659

Merged
merged 11 commits into from
Sep 21, 2021

Conversation

willarmiros
Copy link
Contributor

@willarmiros willarmiros commented Sep 10, 2021

Which problem is this PR solving?

Short description of the changes

I tested these changes via an identical action in a dummy repo. You can see it completing a successful release here: https://github.com/willarmiros/test-package-lock-repo/runs/3618032476?check_suite_focus=true

@codecov
Copy link

codecov bot commented Sep 10, 2021

Codecov Report

Merging #659 (ceb75c1) into main (e7e0e00) will decrease coverage by 1.60%.
The diff coverage is n/a.

❗ Current head ceb75c1 differs from pull request most recent head 77b0708. Consider uploading reports for the commit 77b0708 to get more accurate results

@@            Coverage Diff             @@
##             main     #659      +/-   ##
==========================================
- Coverage   96.68%   95.08%   -1.61%     
==========================================
  Files          13      173     +160     
  Lines         634    12267   +11633     
  Branches      124     1172    +1048     
==========================================
+ Hits          613    11664   +11051     
- Misses         21      603     +582     
Impacted Files Coverage Δ
...metry-instrumentation-document-load/src/version.ts
...ry-instrumentation-user-interaction/src/version.ts
...extension-autoinjection/test/contentScript.test.ts 100.00% <0.00%> (ø)
...metry-instrumentation-memcached/test/index.test.ts 93.47% <0.00%> (ø)
...ntelemetry-instrumentation-dns/test/utils/utils.ts 33.33% <0.00%> (ø)
...ource-detector-aws/src/detectors/AwsEcsDetector.ts 100.00% <0.00%> (ø)
...detector-aws/src/detectors/AwsBeanstalkDetector.ts 95.65% <0.00%> (ø)
...-instrumentation-nestjs-core/src/enums/NestType.ts 100.00% <0.00%> (ø)
...metry-resource-detector-aws/src/detectors/index.ts 100.00% <0.00%> (ø)
...de/opentelemetry-instrumentation-hapi/src/types.ts 100.00% <0.00%> (ø)
... and 156 more

@willarmiros
Copy link
Contributor Author

I'll leave this as a draft since it's blocked on #657, which ought to be the final manual, repo-wide release in contrib. But it is ready for review, apart from updating RELEASING.md.

"detectors/node/opentelemetry-resource-detector-github": "0.25.0",
"metapackages/auto-instrumentations-node": "0.25.0",
"metapackages/auto-instrumentations-web": "0.25.0",
"packages/opentelemetry-browser-extension-autoinjection": "0.25.0",
Copy link
Member

Choose a reason for hiding this comment

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

The manifest will be regenerated anyway on the next release so having extra entries is actually not a problem. Missing entries would be a bigger deal.

@willarmiros willarmiros marked this pull request as ready for review September 13, 2021 16:50
@willarmiros willarmiros requested a review from a team September 13, 2021 16:50
@willarmiros
Copy link
Contributor Author

willarmiros commented Sep 13, 2021

@dyladan Do we want to also include releasing to NPM & GitHub in the release-please workflow as part of this PR, or should we do that in a separate PR? Reference: https://github.com/googleapis/release-please#automating-publication-to-npm

@dyladan
Copy link
Member

dyladan commented Sep 15, 2021

@willarmiros whatever is easier for you

@willarmiros
Copy link
Contributor Author

@dyladan I'll just update this PR to include the NPM and GH release steps

@willarmiros
Copy link
Contributor Author

@obecny @vmarchaud I've finished the release-please automation for contrib and tested it as stated in description. PTAL if you have a chance :)

Copy link
Member

@vmarchaud vmarchaud left a comment

Choose a reason for hiding this comment

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

lgtm

@obecny
Copy link
Member

obecny commented Sep 16, 2021

from code perspective it looks fine, but I will defer the review to @dyladan who is more familiar with releasing

Copy link
Member

@dyladan dyladan 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 just some minor clarifications


# The logic below handles the npm publication:
- name: Checkout Repository
if: ${{ steps.release.outputs.releases_created }}
Copy link
Member

Choose a reason for hiding this comment

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

Is releases meant to be plural? I might be misremembering but i thought it was singular.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I believe their README is incorrect. I submitted a PR to correct it: googleapis/release-please#1057

Based on my output from this test run it's plural: https://github.com/willarmiros/test-package-lock-repo/runs/3617992025?check_suite_focus=true#step:3:4

.github/workflows/release-please.yml Outdated Show resolved Hide resolved
.github/workflows/release-please.yml Outdated Show resolved Hide resolved
@willarmiros
Copy link
Contributor Author

@dyladan is this ready for merging?

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.

9 participants