Skip to content

Add prerelease package notes #225

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Aug 9, 2025
Merged

Add prerelease package notes #225

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9622f2b
Add prerelease package notes
martincostello Aug 8, 2025
3782729
Apply suggestions from code review
martincostello Aug 8, 2025
7a2c08b
Apply suggestions from code review
martincostello Aug 8, 2025
e7b6057
Apply suggestions from code review
martincostello Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,46 @@
* Ask questions on the [Discussions page][discussions].
* [File an issue][issues] for bugs, issues, and feature suggestions.

## Prerelease Packages

We publish prerelease packages to [feedz.io][feedz-io] for testing and feedback
purposes from our repository's continuous integration in GitHub Actions.

These package versions may contain new features or changes that are not yet
available in a stable release, which you can use to test the latest functionality
with your applications ahead of them being published as part of a stable release
to NuGet.org.

To install a prerelease version of our NuGet package, perform the following steps.

First, add/update your NuGet configuration file (e.g., `NuGet.config`) to include
our custom NuGet package source:

```xml
<configuration>
<packageSources>
<add key="grafana-opentelemetry-dotnet" value="https://f.feedz.io/grafana/grafana-opentelemetry-dotnet/nuget/index.json" />
</packageSources>
</configuration>
```

Then, run the following command to add a package reference to the latest
prerelease version in feedz.io to the appropriate project(s) in your application:

```sh
dotnet add package Grafana.OpenTelemetry --prerelease
```

> [!IMPORTANT]

Check failure on line 141 in README.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces 

README.md:141:15 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
> Our prerelease package versions are provided solely for the purposes of early feedback.
>
> These package versions are not supported for use in production applications.
[app-o11y]: https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/
[ci-badge]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/ci.yml/badge.svg?branch=main
[ci-status]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/ci.yml
[discussions]: https://github.com/grafana/grafana-opentelemetry-dotnet/discussions
[feedz-io]: https://github.com/grafana/grafana-opentelemetry-dotnet/deployments/feedz.io
[issues]: https://github.com/grafana/grafana-opentelemetry-dotnet/issues/new
[oats-badge]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/oats.yml/badge.svg?branch=main
[oats-status]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/oats.yml
Expand Down
Loading