-
Notifications
You must be signed in to change notification settings - Fork 0
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
chore: updating CICD and pkg/sdk/client files to integrate dotnet-client-sdk into dotnet-core repo #5
Merged
tanderson-ld
merged 5 commits into
main
from
ta/sc-244785/migrating-dotnet-client-sdk-take2
Jun 12, 2024
Merged
chore: updating CICD and pkg/sdk/client files to integrate dotnet-client-sdk into dotnet-core repo #5
Changes from all commits
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 9fe54b3
chore: updating various READMEs, project URLs, documentation URLs, an…
tanderson-ld 780e8a5
Review comment, server should be client
tanderson-ld be62b6f
review comments
tanderson-ld 17df81f
Merge branch 'main' into ta/sc-244785/migrating-dotnet-client-sdk-take2
tanderson-ld File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,4 +33,5 @@ runs: | |
uses: launchdarkly/gh-actions/actions/[email protected] | ||
with: | ||
test_service_port: 8000 | ||
extra_params: '--status-timeout=120' | ||
token: ${{ inputs.token }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
name: LaunchDarkly.ClientSdk CI | ||
on: | ||
push: | ||
branches: [main, 'feat/**'] | ||
paths-ignore: | ||
- '**.md' # Do not need to run CI for markdown changes. | ||
pull_request: | ||
branches: [main, 'feat/**'] | ||
paths-ignore: | ||
- '**.md' | ||
|
||
jobs: | ||
build-and-test: | ||
strategy: | ||
matrix: | ||
# TODO: Figure out mechanism to skip iOS framework on ubuntu and windows and re-add ubuntu and windows | ||
os: [macos-latest] | ||
fail-fast: false | ||
runs-on: ${{ matrix.os }} | ||
permissions: | ||
id-token: write | ||
contents: read | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: launchdarkly/gh-actions/actions/[email protected] | ||
name: Get secrets | ||
with: | ||
aws_assume_role: ${{ vars.AWS_ROLE_ARN }} | ||
|
||
- name: Download snk | ||
shell: bash | ||
run: aws s3 cp s3://launchdarkly-releaser/dotnet/LaunchDarkly.ClientSdk.snk LaunchDarkly.ClientSdk.snk | ||
|
||
- uses: ./.github/actions/ci | ||
with: | ||
project_file: pkgs/sdk/client/src/LaunchDarkly.ClientSdk.csproj | ||
test_project_file: pkgs/sdk/client/test/LaunchDarkly.ClientSdk.Tests/LaunchDarkly.ClientSdk.Tests.csproj | ||
|
||
- uses: ./.github/actions/contract-tests | ||
with: | ||
service_project_file: pkgs/sdk/client/contract-tests/TestService.csproj | ||
service_dll_file: pkgs/sdk/client/contract-tests/bin/debug/net7.0/ContractTestService.dll | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
- uses: ./.github/actions/build-docs | ||
with: | ||
workspace_path: pkgs/sdk/client |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,8 +16,17 @@ jobs: | |
os: [ubuntu-latest, windows-latest, macos-latest] | ||
fail-fast: false | ||
runs-on: ${{ matrix.os }} | ||
permissions: | ||
id-token: write | ||
contents: read | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: launchdarkly/gh-actions/actions/[email protected] | ||
name: Get secrets | ||
with: | ||
aws_assume_role: ${{ vars.AWS_ROLE_ARN }} | ||
|
||
- uses: ./.github/actions/ci | ||
with: | ||
project_file: pkgs/sdk/server/src/LaunchDarkly.ServerSdk.csproj | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,8 +16,17 @@ jobs: | |
os: [ubuntu-latest, windows-latest, macos-latest] | ||
fail-fast: false | ||
runs-on: ${{ matrix.os }} | ||
permissions: | ||
id-token: write | ||
contents: read | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: launchdarkly/gh-actions/actions/[email protected] | ||
name: Get secrets | ||
with: | ||
aws_assume_role: ${{ vars.AWS_ROLE_ARN }} | ||
|
||
- uses: ./.github/actions/ci | ||
with: | ||
project_file: pkgs/telemetry/src/LaunchDarkly.ServerSdk.Telemetry.csproj | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,78 +1,15 @@ | ||
# Contributing to the LaunchDarkly Server-Side SDK for .NET | ||
# Contributing to the LaunchDarkly .NET Core repository | ||
|
||
LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkly.com/sdk/concepts/contributors-guide) that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK. | ||
|
||
## Submitting bug reports and feature requests | ||
|
||
The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/dotnet-server-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 | ||
|
||
We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days. | ||
|
||
## Build instructions | ||
|
||
### Prerequisites | ||
|
||
To set up your SDK build time environment, you must [download .NET development tools and follow the instructions](https://dotnet.microsoft.com/download). .NET 5.0 is preferred, since the .NET 5.0 tools are able to build for all supported target platforms. | ||
|
||
This SDK shares part of its implementation and public API with the [Xamarin SDK](https://github.com/launchdarkly/xamarin-client-sdk). The shared code is in two other packages: | ||
|
||
* `LaunchDarkly.CommonSdk` (in [`launchdarkly/dotnet-sdk-common`](https://github.com/launchdarkly/dotnet-sdk-common): Types such as `User` that are part of the SDK's public API, but are not specific to server-side or client-side use. | ||
* `LaunchDarkly.InternalSdk` (in [`launchdarkly/dotnet-sdk-internal`](https://github.com/launchdarkly/dotnet-sdk-internal): Support code that is not part of the SDK's public API, such as the implementation of analytics event processing. These types are public in order to be usable from outside of their assembly, but they are not included in the SDK's public API or documentation. | ||
|
||
Other support code is in the packages [`LaunchDarkly.EventSource`](https://github.com/launchdarkly/dotnet-eventsource) and [`LaunchDarkly.Logging`](https://github.com/launchdarkly/dotnet-logging). | ||
|
||
### Building | ||
|
||
To install all required packages: | ||
|
||
```bash | ||
dotnet restore | ||
``` | ||
|
||
Then, to build the SDK for all target frameworks: | ||
|
||
```bash | ||
dotnet build src/LaunchDarkly.ServerSdk | ||
``` | ||
|
||
Or, in Linux: | ||
|
||
```bash | ||
make | ||
``` | ||
|
||
Or, to build for only one target framework (in this example, .NET Standard 2.0): | ||
|
||
```bash | ||
dotnet build src/LaunchDarkly.ServerSdk -f netstandard2.0 | ||
``` | ||
|
||
### Testing | ||
|
||
To run all unit tests: | ||
|
||
```bash | ||
dotnet test test/LaunchDarkly.ServerSdk.Tests/LaunchDarkly.ServerSdk.Tests.csproj | ||
``` | ||
|
||
Or, in Linux: | ||
|
||
```bash | ||
make test | ||
``` | ||
|
||
Note that the unit tests can only be run in Debug configuration. There is an `InternalsVisibleTo` directive that allows the test code to access internal members of the library, and assembly strong-naming in the Release configuration interferes with this. | ||
|
||
To run the SDK contract test suite in Linux (see [`contract-tests/README.md`](./contract-tests/README.md)): | ||
|
||
```bash | ||
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. | ||
|
||
See [`docs-src/README.md`](./docs-src/README.md) for more details. | ||
Build instructions for a package can be found in the package's source directory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.