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: attempt to prevent non-releasing packages from being included in release-please release PRs #1939

Conversation

trentm
Copy link
Contributor

@trentm trentm commented Feb 14, 2024

This continues on from #1928. The non-releasing packages are being added to the
release-please manifest in the hope that this prevents them from being listed
in the set of released packages in a release-please PR. This is
effectively Option 1b from #1917.


/cc @pichlermarc

I chose to reset the version for all the examples packages to "0.1.0" to just have a static common value. Some of them had attempted to track the matching instrumentation version, but many of them didn't keep up, so I think the "version" field on the examples packages is just misleading.

I did not change the version on the sampler-aws-xray package in case there is some user that happened to be using it when installing the package manually from the repo dir.

The effective manifest diff is this:

% diff -u .release-please-manifest.json.pretty .release-please-manifest.json
--- .release-please-manifest.json.pretty	2024-02-14 10:17:13
+++ .release-please-manifest.json	2024-02-14 10:18:36
@@ -12,6 +12,7 @@
   "packages/opentelemetry-id-generator-aws-xray": "1.2.1",
   "packages/opentelemetry-propagation-utils": "0.30.6",
   "packages/opentelemetry-redis-common": "0.36.1",
+  "packages/opentelemetry-sampler-aws-xray": "0.34.0",
   "packages/opentelemetry-sql-common": "0.40.0",
   "packages/opentelemetry-test-utils": "0.36.0",
   "plugins/node/instrumentation-amqplib": "0.34.0",
@@ -25,10 +26,12 @@
   "plugins/node/opentelemetry-instrumentation-aws-lambda": "0.38.0",
   "plugins/node/opentelemetry-instrumentation-aws-sdk": "0.38.1",
   "plugins/node/opentelemetry-instrumentation-bunyan": "0.35.0",
+  "plugins/node/opentelemetry-instrumentation-bunyan/examples": "0.1.0",
   "plugins/node/opentelemetry-instrumentation-cassandra": "0.35.0",
   "plugins/node/opentelemetry-instrumentation-connect": "0.33.0",
   "plugins/node/opentelemetry-instrumentation-dns": "0.33.0",
   "plugins/node/opentelemetry-instrumentation-express": "0.35.0",
+  "plugins/node/opentelemetry-instrumentation-express/examples": "0.1.0",
   "plugins/node/opentelemetry-instrumentation-fastify": "0.33.0",
   "plugins/node/opentelemetry-instrumentation-generic-pool": "0.33.0",
   "plugins/node/opentelemetry-instrumentation-graphql": "0.37.0",
@@ -36,15 +39,19 @@
   "plugins/node/opentelemetry-instrumentation-ioredis": "0.37.0",
   "plugins/node/opentelemetry-instrumentation-knex": "0.33.0",
   "plugins/node/opentelemetry-instrumentation-koa": "0.37.0",
+  "plugins/node/opentelemetry-instrumentation-koa/examples": "0.1.0",
   "plugins/node/opentelemetry-instrumentation-memcached": "0.33.0",
   "plugins/node/opentelemetry-instrumentation-mongodb": "0.39.0",
+  "plugins/node/opentelemetry-instrumentation-mongodb/examples": "0.1.0",
   "plugins/node/opentelemetry-instrumentation-mysql": "0.35.0",
+  "plugins/node/opentelemetry-instrumentation-mysql/examples": "0.1.0",
   "plugins/node/opentelemetry-instrumentation-mysql2": "0.35.0",
   "plugins/node/opentelemetry-instrumentation-nestjs-core": "0.34.0",
   "plugins/node/opentelemetry-instrumentation-net": "0.33.0",
   "plugins/node/opentelemetry-instrumentation-pg": "0.38.0",
   "plugins/node/opentelemetry-instrumentation-pino": "0.35.0",
   "plugins/node/opentelemetry-instrumentation-redis": "0.36.0",
+  "plugins/node/opentelemetry-instrumentation-redis/examples": "0.1.0",
   "plugins/node/opentelemetry-instrumentation-redis-4": "0.36.0",
   "plugins/node/opentelemetry-instrumentation-restify": "0.35.0",
   "plugins/node/opentelemetry-instrumentation-router": "0.34.0",

…in release-please release PRs

This continues on from open-telemetry#1928. The non-releasing packages are being added to the
release-please manifest in the hope that this prevents them from being listed
in the set of released packages in a release-please PR. This is
effectively Option 1b from open-telemetry#1917.
Copy link

codecov bot commented Feb 14, 2024

Codecov Report

Merging #1939 (9e2f32e) into main (f4e6f11) will not change coverage.
The diff coverage is n/a.

❗ Current head 9e2f32e differs from pull request most recent head 9281b48. Consider uploading reports for the commit 9281b48 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1939   +/-   ##
=======================================
  Coverage   91.02%   91.02%           
=======================================
  Files         146      146           
  Lines        7478     7478           
  Branches     1497     1497           
=======================================
  Hits         6807     6807           
  Misses        671      671           

Copy link
Member

@pichlermarc pichlermarc 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, let's merge this in. 🙂

@pichlermarc pichlermarc merged commit dbf2c96 into open-telemetry:main Feb 15, 2024
15 checks passed
@trentm trentm deleted the tm-1917-option-1b-add-release-please-manifest branch February 15, 2024 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants