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

rel: prepare v1.3.0/v0.27.0-beta #340

Merged
merged 10 commits into from
Mar 3, 2023
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# honeycomb-opentelemetry-dotnet changelog

## [1.3.0/0.27.0-beta] - 2023-03-02

### !!! Breaking Changes !!!

### Maintenance
JamieDanielson marked this conversation as resolved.
Show resolved Hide resolved

- maint: Rename AutoInstrumentations package to CommonInstrumentations (#327) | [@MikeGoldsmith](https://github.com/MikeGoldsmith)
- renamed the package to make it more clear that this is common instrumentation, not technically "automatic" instrumentation.
- `Honeycomb.OpenTelemetry.AutoInstrumentations` -> `Honeycomb.OpenTelemetry.CommonInstrumentations`
- `AddAutoInstrumentations` -> `AddCommonInstrumentations`
- maint: Update OpenTelemetry instrumentation packages (#334) | [@MikeGoldsmith](https://github.com/MikeGoldsmith)
- The new `OpenTelemetry` packages change how tracing and metrics are setup
- `AddOpenTelemetryTracing` -> `AddOpenTelemetry().WithTracing`
- `AddOpenTelemetryMetrics` -> `AddOpenTelemetry().WithMetrics`
- maint(deps): bump OpenTelemetry.Instrumentation.StackExchangeRedis from 1.0.0-rc9.7 to 1.0.0-rc9.8 (#345)
- maint(deps): bump Microsoft.NET.Test.Sdk from 17.3.2 to 17.4.1 (#336)
- maint: new signed snkgpg, use long cmd lines for clarity (#341) | [@JamieDanielson](https://github.com/JamieDanielson)

## [1.2.1/0.26.1-beta] - 2022-11-22

### Fixes
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ It makes getting started with OpenTelemetry and Honeycomb easier!

Latest release built with:

- [OpenTelemetry Version 1.3.0](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/core-1.3.0)
- [OpenTelemetry Version 1.4.0](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/core-1.4.0)

## Getting Started

Expand Down
21 changes: 14 additions & 7 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
# Releasing Process

1. Update changelog
2. Update VersionPrefix (and VersionSuffix if necessary) in the csproj file
- If updating the OTel SDK, update the OTLP version in `HoneycombOptions.cs`
3. Open a PR with the above, and merge that into main
4. Tag the merged commit with the new version (e.g. `v0.10.0-alpha`)
5. Push the tag upstream (this will kick off the release pipeline in CI)
6. Once the CI is done, publish the GitHub draft release as pre-release through GitHub UI
- Update `CHANGELOG.md` with the changes since the last release. Consider automating with a command such as these two:
- `git log $(git describe --tags --abbrev=0)..HEAD --no-merges --oneline > new-in-this-release.log`
- `git log --pretty='%C(green)%d%Creset- %s | [%an](https://github.com/)'`
- Update VersionPrefix (and VersionSuffix if necessary) in the `*.csproj` files
- If updating the OTel SDK, update the OTLP version in `HoneycombOptions.cs`
- If updating the OTel SDK, update the OTel version in `README.md`
- Commit changes, push, and open a release preparation pull request for review.
- Once the pull request is merged, fetch the updated `main` branch.
- Apply a tag for the new version on the merged commit (e.g. `git tag -a v1.3.0 -m "v1.3.0"`)
- Note: We only tag the main package (even if changes were made to the instr packages) so the pipeline doesn't double-run
- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v1.3.0`
- Ensure that there is a draft GitHub release created as part of CI publish steps (this will also publish to Nuget).
- Click "generate release notes" in Github for full changelog notes and any new contributors
- Publish the Github draft release - if it is a prerelease (e.g. beta) click the prerelease checkbox.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<SymbolPackageFormat>snupkg</SymbolPackageFormat>

<!-- NuGet packaging properties -->
<VersionPrefix>0.26.1</VersionPrefix>
<VersionPrefix>0.27.0</VersionPrefix>
<VersionSuffix>beta</VersionSuffix>
<PackageId>Honeycomb.OpenTelemetry.CommonInstrumentations</PackageId>
<Authors>Honeycomb</Authors>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<SymbolPackageFormat>snupkg</SymbolPackageFormat>

<!-- NuGet packaging properties -->
<VersionPrefix>0.26.1</VersionPrefix>
<VersionPrefix>0.27.0</VersionPrefix>
<VersionSuffix>beta</VersionSuffix>
<PackageId>Honeycomb.OpenTelemetry.Instrumentation.AspNetCore</PackageId>
<Authors>Honeycomb</Authors>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<SymbolPackageFormat>snupkg</SymbolPackageFormat>

<!-- NuGet packaging properties -->
<VersionPrefix>1.2.1</VersionPrefix>
<VersionPrefix>1.3.0</VersionPrefix>
<PackageId>Honeycomb.OpenTelemetry</PackageId>
<Authors>Honeycomb</Authors>
<Description>Honeycomb's OpenTelemetry SDK</Description>
Expand Down
2 changes: 1 addition & 1 deletion src/Honeycomb.OpenTelemetry/HoneycombOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace Honeycomb.OpenTelemetry
/// </summary>
public class HoneycombOptions
{
private const string OtlpVersion = "0.18.0";
private const string OtlpVersion = "0.19.0";
private const string OtelExporterOtlpProtocolHttpProtobuf = "http/protobuf";
private const string OtelExporterOtlpProtocolHttpJson = "http/json";
private const string OtelExporterOtlpProtocolGrpc = "grpc";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ public class HoneycombOptionsExtensionsTests
private const string ClassicApiKey = "a142c03cf06936628e60f4c6157fde46";

[Theory]
[InlineData("", "", "x-otlp-version=0.18.0,x-honeycomb-team=")]
[InlineData(ModernApiKey, "", "x-otlp-version=0.18.0,x-honeycomb-team=6936628e60f4c6157fde46")]
[InlineData(ModernApiKey, "dataset", "x-otlp-version=0.18.0,x-honeycomb-team=6936628e60f4c6157fde46")]
[InlineData(ClassicApiKey, "", "x-otlp-version=0.18.0,x-honeycomb-team=a142c03cf06936628e60f4c6157fde46")]
[InlineData(ClassicApiKey, "dataset", "x-otlp-version=0.18.0,x-honeycomb-team=a142c03cf06936628e60f4c6157fde46,x-honeycomb-dataset=dataset")]
[InlineData("", "", "x-otlp-version=0.19.0,x-honeycomb-team=")]
[InlineData(ModernApiKey, "", "x-otlp-version=0.19.0,x-honeycomb-team=6936628e60f4c6157fde46")]
[InlineData(ModernApiKey, "dataset", "x-otlp-version=0.19.0,x-honeycomb-team=6936628e60f4c6157fde46")]
[InlineData(ClassicApiKey, "", "x-otlp-version=0.19.0,x-honeycomb-team=a142c03cf06936628e60f4c6157fde46")]
[InlineData(ClassicApiKey, "dataset", "x-otlp-version=0.19.0,x-honeycomb-team=a142c03cf06936628e60f4c6157fde46,x-honeycomb-dataset=dataset")]
public void TracesHeaders(string apikey, string dataset, string expectedHeader) {
var options = new HoneycombOptions
{
Expand All @@ -22,11 +22,11 @@ public void TracesHeaders(string apikey, string dataset, string expectedHeader)
}

[Theory]
[InlineData("", "", "x-otlp-version=0.18.0,x-honeycomb-team=,x-honeycomb-dataset=")]
[InlineData(ModernApiKey, "", "x-otlp-version=0.18.0,x-honeycomb-team=6936628e60f4c6157fde46,x-honeycomb-dataset=")]
[InlineData(ModernApiKey, "dataset", "x-otlp-version=0.18.0,x-honeycomb-team=6936628e60f4c6157fde46,x-honeycomb-dataset=dataset")]
[InlineData(ClassicApiKey, "", "x-otlp-version=0.18.0,x-honeycomb-team=a142c03cf06936628e60f4c6157fde46,x-honeycomb-dataset=")]
[InlineData(ClassicApiKey, "dataset", "x-otlp-version=0.18.0,x-honeycomb-team=a142c03cf06936628e60f4c6157fde46,x-honeycomb-dataset=dataset")]
[InlineData("", "", "x-otlp-version=0.19.0,x-honeycomb-team=,x-honeycomb-dataset=")]
[InlineData(ModernApiKey, "", "x-otlp-version=0.19.0,x-honeycomb-team=6936628e60f4c6157fde46,x-honeycomb-dataset=")]
[InlineData(ModernApiKey, "dataset", "x-otlp-version=0.19.0,x-honeycomb-team=6936628e60f4c6157fde46,x-honeycomb-dataset=dataset")]
[InlineData(ClassicApiKey, "", "x-otlp-version=0.19.0,x-honeycomb-team=a142c03cf06936628e60f4c6157fde46,x-honeycomb-dataset=")]
[InlineData(ClassicApiKey, "dataset", "x-otlp-version=0.19.0,x-honeycomb-team=a142c03cf06936628e60f4c6157fde46,x-honeycomb-dataset=dataset")]
public void MetricsHeaders(string apikey, string dataset, string expectedHeader) {
var options = new HoneycombOptions
{
Expand Down