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.

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

chore: updating CICD and pkg/sdk/client files to integrate dotnet-client-sdk into dotnet-core repo #5

Merged
merged 5 commits into from
Jun 12, 2024
Merged

chore: updating CICD and pkg/sdk/client files to integrate dotnet-client-sdk into dotnet-core repo #5

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
224c6c2
chore: updating CICD and pkg/sdk/client files to integrate dotnet-cli…
tanderson-ld Jun 7, 2024
9fe54b3
chore: updating various READMEs, project URLs, documentation URLs, an…
tanderson-ld Jun 7, 2024
780e8a5
Review comment, server should be client
tanderson-ld Jun 10, 2024
be62b6f
review comments
tanderson-ld Jun 10, 2024
17df81f
Merge branch 'main' into ta/sc-244785/migrating-dotnet-client-sdk-take2
tanderson-ld Jun 11, 2024
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
33 changes: 19 additions & 14 deletions README.md
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This README.md is the dotnet-server-sdk README. It was copied to pkgs/sdk/server/README.md and then this README.md was gutted/edited to fit the needs of the entire repo.

Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# LaunchDarkly Server-Side SDK for .NET
# LaunchDarkly monorepo for .NET SDKs and C# libs.

The LaunchDarkly Server-Side SDK for .NET is designed primarily for use in multi-user systems such as web servers and applications. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.

For using LaunchDarkly in *client-side* .NET applications, including mobile applications and desktop applications, refer to our [.NET Client SDK](https://github.com/launchdarkly/dotnet-client-sdk).
This repository contains LaunchDarkly SDK packages for usage in .NET.
This includes shared libraries, used by SDKs and other tools, as well as SDKs.

## Packages

| SDK Packages | NuGet | API Docs | Issues | Tests |
|-------------------------------------------|---------------------------------------------------------|-------------------------------------------------------------|-------------------------------|------------------------------------------------------------|
| [LaunchDarkly.ServerSdk](pkgs/sdk/server) | [![NuGet][server-nuget-badge]][server-nuget-link] | [![Documentation][api-docs-badge]][server-api-docs-link] | [Server SDK][server-issues] | [![Actions Status][server-ci-badge]][server-ci-link] |
| [LaunchDarkly.ClientSdk](pkgs/sdk/client) | [![NuGet][client-nuget-badge]][client-nuget-link] | [![Documentation][api-docs-badge]][client-api-docs-link] | [Server SDK][client-issues] | [![Actions Status][client-ci-badge]][client-ci-link] |

tanderson-ld marked this conversation as resolved.
Show resolved Hide resolved
| Telemetry Packages | NuGet | API Docs | Issues | Tests |
|----------------------------------------------------|---------------------------------------------------------|-------------------------------------------------------------|-------------------------------|------------------------------------------------------------|
Expand All @@ -32,8 +32,6 @@ For using LaunchDarkly in *client-side* .NET applications, including mobile appl

Read our [documentation](https://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/server-side/dotnet).

The authoritative description of all types, properties, and methods is in the [generated API documentation](https://launchdarkly.github.io/dotnet-server-sdk/pkgs/sdk/server/).

## Testing

We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test for consistency across SDKs, as well as test networking behavior in a long-running application. These tests cover each method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all behave correctly.
Expand All @@ -59,16 +57,23 @@ We encourage pull requests and other contributions from the community. Check out

[server-nuget-badge]: https://img.shields.io/nuget/v/LaunchDarkly.ServerSdk.svg?style=flat-square
[server-nuget-link]: https://www.nuget.org/packages/LaunchDarkly.ServerSdk/
[server-ci-badge]: https://github.com/launchdarkly/dotnet-server-sdk/actions/workflows/sdk-server-ci.yml/badge.svg
[server-ci-link]: https://github.com/launchdarkly/dotnet-server-sdk/actions/workflows/sdk-server-ci.yml
[server-issues]: https://github.com/launchdarkly/dotnet-server-sdk/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fserver%22+
[server-api-docs-link]: https://launchdarkly.github.io/dotnet-server-sdk/pkgs/sdk/server/
[server-ci-badge]: https://github.com/launchdarkly/dotnet-core/actions/workflows/sdk-server-ci.yml/badge.svg
[server-ci-link]: https://github.com/launchdarkly/dotnet-core/actions/workflows/sdk-server-ci.yml
[server-issues]: https://github.com/launchdarkly/dotnet-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fserver%22+
[server-api-docs-link]: https://launchdarkly.github.io/dotnet-core/pkgs/sdk/server/

[client-nuget-badge]: https://img.shields.io/nuget/v/LaunchDarkly.ClientSdk.svg?style=flat-square
[client-nuget-link]: https://www.nuget.org/packages/LaunchDarkly.ClientSdk/
[client-ci-badge]: https://github.com/launchdarkly/dotnet-core/actions/workflows/sdk-client-ci.yml/badge.svg
[client-ci-link]: https://github.com/launchdarkly/dotnet-core/actions/workflows/sdk-client-ci.yml
[client-issues]: https://github.com/launchdarkly/dotnet-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fclient%22+
[client-api-docs-link]: https://launchdarkly.github.io/dotnet-core/pkgs/sdk/client/

[telemetry-nuget-badge]: https://img.shields.io/nuget/v/LaunchDarkly.ServerSdk.Telemetry.svg?style=flat-square
[telemetry-nuget-link]: https://www.nuget.org/packages/LaunchDarkly.ServerSdk.Telemetry/
[telemetry-ci-badge]: https://github.com/launchdarkly/dotnet-server-sdk/actions/workflows/telemetry-ci.yml/badge.svg
[telemetry-ci-link]: https://github.com/launchdarkly/dotnet-server-sdk/actions/workflows/telemetry-ci.yml
[telemetry-issues]: https://github.com/launchdarkly/dotnet-server-sdk/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+telemetry%22+
[telemetry-api-docs-link]: https://launchdarkly.github.io/dotnet-server-sdk/pkgs/telemetry/
[telemetry-ci-badge]: https://github.com/launchdarkly/dotnet-core/actions/workflows/telemetry-ci.yml/badge.svg
[telemetry-ci-link]: https://github.com/launchdarkly/dotnet-core/actions/workflows/telemetry-ci.yml
[telemetry-issues]: https://github.com/launchdarkly/dotnet-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+telemetry%22+
[telemetry-api-docs-link]: https://launchdarkly.github.io/dotnet-core/pkgs/telemetry/

[api-docs-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
2 changes: 1 addition & 1 deletion pkgs/sdk/client/CONTRIBUTING.md
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reviewers: Refreshed commands, they were very out of data on dotnet-client-sdk repo.

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkl

## Submitting bug reports and feature requests

The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/dotnet-client-sdk/issues) in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.
The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/dotnet-core/issues) in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.

## Submitting pull requests

Expand Down
2 changes: 1 addition & 1 deletion pkgs/sdk/client/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ run-contract-tests:

contract-tests: build-contract-tests start-contract-test-service-bg run-contract-tests

.PHONY: build test clean build-contract-tests start-contract-test-service run-contract-tests contract-tests
.PHONY: build test clean build-contract-tests start-contract-test-service run-contract-tests contract-tests
2 changes: 1 addition & 1 deletion pkgs/sdk/client/README.md
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reviewers: Top level README.md now has nuget links

Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Refer to the [SDK documentation](https://docs.launchdarkly.com/sdk/client-side/d

Read our [documentation](https://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/client-side/dotnet).

The authoritative description of all types, properties, and methods is in the [generated API documentation](https://launchdarkly.github.io/dotnet-client-sdk/).
The authoritative description of all types, properties, and methods is in the [generated API documentation](https://launchdarkly.github.io/dotnet-core/pkgs/sdk/client).

## Testing

Expand Down
2 changes: 1 addition & 1 deletion pkgs/sdk/client/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ For first time users, visit our [LaunchDarkly Docs](https://docs.launchdarkly.co

This site contains the full API reference for the [`LaunchDarkly.ClientSdk`](https://www.nuget.org/packages/LaunchDarkly.ClientSdk) package, as well other packages used by the client package.

For source code, see the [GitHub repository](https://github.com/launchdarkly/dotnet-client-sdk). The [developer notes](https://github.com/launchdarkly/dotnet-client-sdk/blob/main/CONTRIBUTING.md) there include links to other repositories used in the SDK.
For source code, see the [GitHub repository](https://github.com/launchdarkly/dotnet-core). The [developer notes](https://github.com/launchdarkly/core/blob/main/CONTRIBUTING.md) there include links to other repositories used in the SDK.
6 changes: 3 additions & 3 deletions pkgs/sdk/client/scripts/build-test-package.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ set -e
# the test-packages directory as a package source to use this package in our testing tools.

TEST_VERSION="0.0.1-$(date +%Y%m%d.%H%M%S)"
PROJECT_FILE=src/LaunchDarkly.ClientSdk/LaunchDarkly.ClientSdk.csproj
PROJECT_FILE=src/LaunchDarkly.ClientSdk.csproj
SAVE_PROJECT_FILE="${PROJECT_FILE}.orig"
TEST_PACKAGE_DIR=./test-packages

Expand All @@ -22,9 +22,9 @@ temp_file="${PROJECT_FILE}.tmp"
sed "s#^\( *\)<Version>[^<]*</Version>#\1<Version>${TEST_VERSION}</Version>#g" "${PROJECT_FILE}" > "${temp_file}"
mv "${temp_file}" "${PROJECT_FILE}"

msbuild /restore -t:pack "${PROJECT_FILE}"
dotnet build /restore -t:pack "${PROJECT_FILE}"

NUPKG_FILE="src/LaunchDarkly.ClientSdk/bin/Debug/LaunchDarkly.ClientSdk.${TEST_VERSION}.nupkg"
NUPKG_FILE="src/bin/Debug/LaunchDarkly.ClientSdk.${TEST_VERSION}.nupkg"
if [ -f "${NUPKG_FILE}" ]; then
mv "${NUPKG_FILE}" "${TEST_PACKAGE_DIR}"
echo; echo; echo "Success! Created test package version ${TEST_VERSION} in ${TEST_PACKAGE_DIR}"
Expand Down
4 changes: 2 additions & 2 deletions pkgs/sdk/client/src/LaunchDarkly.ClientSdk.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
<Company>LaunchDarkly</Company>
<Copyright>Copyright 2020 LaunchDarkly</Copyright>
<LicenseExpression>Apache-2.0</LicenseExpression>
<PackageProjectUrl>https://github.com/launchdarkly/dotnet-client-sdk</PackageProjectUrl>
<RepositoryUrl>https://github.com/launchdarkly/dotnet-client-sdk</RepositoryUrl>
<PackageProjectUrl>https://github.com/launchdarkly/dotnet-core</PackageProjectUrl>
<RepositoryUrl>https://github.com/launchdarkly/dotnet-core</RepositoryUrl>
<RepositoryBranch>master</RepositoryBranch>
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
Expand Down
4 changes: 2 additions & 2 deletions pkgs/sdk/server/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,6 @@ make contract-tests

## Documentation in code

All public types, methods, and properties should have documentation comments in the standard C# XML comment format. These will be automatically included in the [HTML documentation](https://launchdarkly.github.io/dotnet-server-sdk) that is generated on release; this process also uses additional Markdown content from the `docs-src/` subdirectory.
All public types, methods, and properties should have documentation comments in the standard C# XML comment format. These will be automatically included in the documentation that is generated on release; this process also uses additional Markdown content from the respective packages `docs-src/` subdirectory.

See [`docs-src/README.md`](./docs-src/README.md) for more details.
See `docs-src/README.md` for more details.
2 changes: 1 addition & 1 deletion pkgs/sdk/server/README.md
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reviewers: This is the README.md that was in the dotnet-server-sdk repo, Git didn't detect the move since it was also edited to fit the needs of this repo.

Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Public Key Token: f86add69004e6885

Read our [documentation](https://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/server-side/dotnet).

The authoritative description of all types, properties, and methods is in the [generated API documentation](https://launchdarkly.github.io/dotnet-server-sdk/).
The authoritative description of all types, properties, and methods is in the [generated API documentation](https://launchdarkly.github.io/dotnet-core/pkgs/sdk/server).

## Testing

Expand Down
2 changes: 1 addition & 1 deletion pkgs/sdk/server/docs-src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Notes on in-code documentation for this project

All public types, methods, and properties should have documentation comments in the standard C# XML comment format.
These will be automatically included in the [HTML documentation](https://launchdarkly.github.io/dotnet-server-sdk) that is generated on release.
These will be automatically included in the [HTML documentation](https://launchdarkly.github.io/dotnet-core/pkgs/sdk/server) that is generated on release.

Non-public items may have documentation comments as well, since those may be helpful to other developers working on this
project, but they will not be included in the HTML documentation.
Expand Down
4 changes: 2 additions & 2 deletions pkgs/sdk/server/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ starting points to explore from.
This site contains the full API reference for the [`LaunchDarkly.ServerSdk`](https://www.nuget.org/packages/LaunchDarkly.ServerSdk)
package, as well as the `LaunchDarkly.CommonSdk` package that is included automatically as a dependency of the SDK.

For source code, see the [GitHub repository](https://github.com/launchdarkly/dotnet-server-sdk).
The [developer notes](https://github.com/launchdarkly/dotnet-server-sdk/blob/main/CONTRIBUTING.md) there include links
For source code, see the [GitHub repository](https://github.com/launchdarkly/dotnet-core).
The [developer notes](https://github.com/launchdarkly/dotnet-core/blob/main/CONTRIBUTING.md) there include links
to other repositories used in the SDK.


Expand Down
4 changes: 2 additions & 2 deletions pkgs/sdk/server/src/LaunchDarkly.ServerSdk.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
<Company>LaunchDarkly</Company>
<Copyright>Copyright 2020 LaunchDarkly</Copyright>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/launchdarkly/dotnet-server-sdk</PackageProjectUrl>
<RepositoryUrl>https://github.com/launchdarkly/dotnet-server-sdk</RepositoryUrl>
<PackageProjectUrl>https://github.com/launchdarkly/dotnet-core</PackageProjectUrl>
<RepositoryUrl>https://github.com/launchdarkly/dotnet-core</RepositoryUrl>
<RepositoryBranch>main</RepositoryBranch>
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
Expand Down
4 changes: 2 additions & 2 deletions pkgs/telemetry/src/LaunchDarkly.ServerSdk.Telemetry.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
<Company>LaunchDarkly</Company>
<Copyright>Copyright 2024 LaunchDarkly</Copyright>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/launchdarkly/dotnet-server-sdk</PackageProjectUrl>
<RepositoryUrl>https://github.com/launchdarkly/dotnet-server-sdk</RepositoryUrl>
<PackageProjectUrl>https://github.com/launchdarkly/dotnet-corek</PackageProjectUrl>
<RepositoryUrl>https://github.com/launchdarkly/dotnet-core</RepositoryUrl>
<RepositoryBranch>main</RepositoryBranch>
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
Expand Down
Loading