Skip to content

Commit 9622f2b

Browse files
Add prerelease package notes
Add a note to the README about how to consume prerelease packages from feedz.io.
1 parent be48d43 commit 9622f2b

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,46 @@ To engage with the Grafana Application Observability community:
108108
* Ask questions on the [Discussions page][discussions].
109109
* [File an issue][issues] for bugs, issues, and feature suggestions.
110110

111+
## Prerelease Packages
112+
113+
We publish prerelease packages to [feedz.io][feedz-io] for testing and feedback
114+
purposes from our repository's continuous integration in GitHub Actions.
115+
116+
These package versions may contain new features or changes that are not yet
117+
available in a stable release, which you can use to test the latest functionality
118+
with your applications ahread of them being published as part of a stable release
119+
to NuGet.org.
120+
121+
To install a prerelease version of our NuGet package, perform the following steps.
122+
123+
First, add/update your NuGet configuration file (e.g., `NuGet.config`) to include
124+
our custom NuGet package source:
125+
126+
```xml
127+
<configuration>
128+
<packageSources>
129+
<add key="grafana-opentelemetry-dotnet" value="https://f.feedz.io/grafana/grafana-opentelemetry-dotnet/nuget/index.json" />
130+
</packageSources>
131+
</configuration>
132+
```
133+
134+
Then, run the following command to add a package reference to the latest
135+
prerelease version in feedz.io to the appropriate project(s) in your application:
136+
137+
```sh
138+
dotnet add package Grafana.OpenTelemetry --prerelease
139+
```
140+
141+
> [!NOTE]
142+
> Our prerelease package versions are provided solely for the purposes of early feedback.
143+
>
144+
> These package versions are not supported for use in production applications.
145+
111146
[app-o11y]: https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/
112147
[ci-badge]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/ci.yml/badge.svg?branch=main
113148
[ci-status]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/ci.yml
114149
[discussions]: https://github.com/grafana/grafana-opentelemetry-dotnet/discussions
150+
[feedz-io]: https://github.com/grafana/grafana-opentelemetry-dotnet/deployments/feedz.io
115151
[issues]: https://github.com/grafana/grafana-opentelemetry-dotnet/issues/new
116152
[oats-badge]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/oats.yml/badge.svg?branch=main
117153
[oats-status]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/oats.yml

0 commit comments

Comments
 (0)