|
| 1 | +# Releasing OpenTelemetry.OutOfProcess.Forwarder Packages |
| 2 | + |
| 3 | +This document describes how to release the OpenTelemetry.OutOfProcess.Forwarder packages. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +The OpenTelemetry.OutOfProcess.Forwarder consists of two NuGet packages: |
| 8 | +- **OpenTelemetry.OutOfProcess.Forwarder** - Core forwarder functionality |
| 9 | +- **OpenTelemetry.OutOfProcess.Forwarder.Configuration** - Configuration extensions |
| 10 | + |
| 11 | +## Release Process |
| 12 | + |
| 13 | +### 1. Prepare for Release |
| 14 | + |
| 15 | +1. Ensure all changes are merged to the `out-of-process-collection` branch |
| 16 | +2. Update version numbers and changelog if needed |
| 17 | +3. Verify all tests are passing |
| 18 | + |
| 19 | +### 2. Build Release Packages |
| 20 | + |
| 21 | +1. Navigate to the repository's **Actions** tab |
| 22 | +2. Select the **release-nextgen-forwarder-packages** workflow |
| 23 | +3. Click **Run workflow** |
| 24 | +4. Fill in the required parameters: |
| 25 | + - **Version**: Enter the release version (e.g., `1.0.0`, `1.0.0-alpha.1`, `1.0.0-beta.1`) |
| 26 | + - Ensure you're running from the `out-of-process-collection` branch |
| 27 | +5. Click **Run workflow** |
| 28 | + |
| 29 | +### 3. Verify Build |
| 30 | + |
| 31 | +1. Wait for the workflow to complete successfully |
| 32 | +2. Check the workflow summary for: |
| 33 | + - ✅ All tests passed |
| 34 | + - ✅ Packages were built and validated |
| 35 | + - ✅ Package sizes are reasonable |
| 36 | + - ✅ Artifact was uploaded |
| 37 | + |
| 38 | +### 4. Download and Publish Packages |
| 39 | + |
| 40 | +1. From the completed workflow run, download the `opentelemetry-nextgen-forwarder-packages` artifact |
| 41 | +2. Extract the `.nupkg` files from the downloaded zip |
| 42 | +3. Verify the package contents if needed: |
| 43 | + ```bash |
| 44 | + dotnet validate package local OpenTelemetry.OutOfProcess.Forwarder.{version}.nupkg |
| 45 | + dotnet validate package local OpenTelemetry.OutOfProcess.Forwarder.Configuration.{version}.nupkg |
| 46 | + ``` |
| 47 | + |
| 48 | +4. Publish to NuGet.org using your API key: |
| 49 | + ```bash |
| 50 | + dotnet nuget push OpenTelemetry.OutOfProcess.Forwarder.{version}.nupkg --api-key YOUR_API_KEY --source https://api.nuget.org/v3/index.json |
| 51 | + dotnet nuget push OpenTelemetry.OutOfProcess.Forwarder.Configuration.{version}.nupkg --api-key YOUR_API_KEY --source https://api.nuget.org/v3/index.json |
| 52 | + ``` |
| 53 | + |
| 54 | +### 5. Verify Publication |
| 55 | + |
| 56 | +1. Check that packages appear on [nuget.org](https://www.nuget.org/packages?q=OpenTelemetry.OutOfProcess.Forwarder) |
| 57 | +2. Verify package metadata and dependencies are correct |
| 58 | +3. Test installation in a sample project: |
| 59 | + ```bash |
| 60 | + dotnet add package OpenTelemetry.OutOfProcess.Forwarder --version {version} |
| 61 | + dotnet add package OpenTelemetry.OutOfProcess.Forwarder.Configuration --version {version} |
| 62 | + ``` |
| 63 | + |
| 64 | +## Versioning Guidelines |
| 65 | + |
| 66 | +- **Stable releases**: Use semantic versioning (e.g., `1.0.0`, `1.1.0`, `2.0.0`) |
| 67 | +- **Preview releases**: Use preview suffixes (e.g., `1.0.0-alpha.1`, `1.0.0-beta.1`, `1.0.0-rc.1`) |
| 68 | +- **Development builds**: Use preview suffixes with build numbers (e.g., `1.0.0-alpha.1.123`) |
| 69 | + |
| 70 | +## Troubleshooting |
| 71 | + |
| 72 | +### Build Failures |
| 73 | +- Check that all project references are valid |
| 74 | +- Ensure the `out-of-process-collection` branch is up to date |
| 75 | +- Verify that tests are passing locally |
| 76 | + |
| 77 | +### Package Validation Failures |
| 78 | +- Review package dependencies and target frameworks |
| 79 | +- Check for missing required metadata in `.csproj` files |
| 80 | +- Ensure package content is properly included |
| 81 | + |
| 82 | +### Publishing Failures |
| 83 | +- Verify NuGet API key is valid and has correct permissions |
| 84 | +- Check that package versions don't already exist (unless using `--skip-duplicate`) |
| 85 | +- Ensure package names match exactly |
| 86 | + |
| 87 | +## Related Documents |
| 88 | + |
| 89 | +- [Main Repository Releasing Guide](../docs/releasing.md) |
| 90 | +- [Package Configuration](src/OpenTelemetry.OutOfProcess.Forwarder/OpenTelemetry.OutOfProcess.Forwarder.csproj) |
| 91 | +- [Workflow Definition](../.github/workflows/release-nextgen-forwarder-packages.yml) |
0 commit comments