-
Notifications
You must be signed in to change notification settings - Fork 569
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add justfile, remove coveralls (#3040)
* add justfile * update docs, ci, and justfile * run CI * remove rest of coveralls * update justfile again * use quiet mode * add groups * removed groups from justfile and removed comment from CI * update arguemtn name * Add comment * update ci * revert to gh action
- Loading branch information
1 parent
b7fb5eb
commit 90e57f6
Showing
4 changed files
with
76 additions
and
67 deletions.
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
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 |
---|---|---|
|
@@ -30,10 +30,10 @@ From within Visual Studio: | |
|
||
1. Open the Solution Explorer. | ||
2. Right-click on a project within your solution. | ||
3. Click on *Manage NuGet Packages...* | ||
4. Click on the *Browse* tab and search for "Stripe.net". | ||
3. Click on _Manage NuGet Packages..._ | ||
4. Click on the _Browse_ tab and search for "Stripe.net". | ||
5. Click on the Stripe.net package, select the appropriate version in the | ||
right-tab and click *Install*. | ||
right-tab and click _Install_. | ||
|
||
## Documentation | ||
|
||
|
@@ -49,15 +49,15 @@ Stripe authenticates API requests using your account’s secret key, which you c | |
|
||
Use `StripeConfiguration.ApiKey` property to set the secret key. | ||
|
||
``` C# | ||
```C# | ||
StripeConfiguration.ApiKey = "sk_test_..."; | ||
``` | ||
|
||
### Creating a resource | ||
|
||
The `Create` method of the service class can be used to create a new resource: | ||
|
||
``` C# | ||
```C# | ||
var options = new CustomerCreateOptions | ||
{ | ||
Email = "[email protected]" | ||
|
@@ -74,7 +74,7 @@ Console.WriteLine(customer.Email); | |
|
||
The `Retrieve` method of the service class can be used to retrieve a resource: | ||
|
||
``` C# | ||
```C# | ||
var service = new CustomerService(); | ||
Customer customer = service.Get("cus_1234"); | ||
|
||
|
@@ -320,10 +320,13 @@ go install github.com/stripe/stripe-mock@latest | |
stripe-mock | ||
``` | ||
|
||
Lastly, we use [just](https://github.com/casey/just) for running common development tasks. You can also read the `justfile` and run those commands directly. | ||
|
||
Run all tests from the `src/StripeTests` directory: | ||
|
||
```sh | ||
dotnet test src | ||
just test | ||
# or: dotnet test src | ||
``` | ||
|
||
Run some tests, filtering by name: | ||
|
@@ -343,7 +346,8 @@ must be formatted before PRs are submitted, otherwise CI will fail. Run the | |
formatter with: | ||
|
||
```sh | ||
dotnet format src/Stripe.net.sln | ||
just format | ||
# or: dotnet format src/Stripe.net.sln | ||
``` | ||
|
||
For any requests, bug or comments, please [open an issue][issues] or [submit a | ||
|
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,37 @@ | ||
set quiet | ||
|
||
import? '../sdk-codegen/justfile' | ||
|
||
_default: | ||
just --list --unsorted | ||
|
||
# base test command that other, more specific commands use | ||
[no-quiet] | ||
[no-exit-message] | ||
_test no_build framework config: | ||
dotnet test {{no_build}} {{framework}} src/StripeTests/StripeTests.csproj -c {{config}} | ||
|
||
# ⭐ run tests in debug mode | ||
test: (_test "" "-f net8.0" "Debug") | ||
|
||
# skip build and don't specify the dotnet framework | ||
ci-test: (_test "--no-build" "" "Release") | ||
|
||
# ⭐ format all files | ||
format *args: | ||
# This sets TargetFramework because of a race condition in dotnet format when it tries to format to multiple targets at a time, which could lead to code with compiler errors after it completes | ||
TargetFramework=net5.0 dotnet format src/Stripe.net/Stripe.net.csproj --severity warn {{args}} | ||
|
||
# for backwards compatibility; ideally removed later | ||
[private] | ||
alias codegen-format := format | ||
|
||
# verify, but don't modify, the project's formatting | ||
format-check: (format "--verify-no-changes") | ||
|
||
# called by tooling | ||
[private] | ||
update-version version: | ||
echo "{{ version }}" > VERSION | ||
perl -pi -e 's|<Version>[.\-\d\w]+</Version>|<Version>{{ version }}</Version>|' src/Stripe.net/Stripe.net.csproj | ||
perl -pi -e 's|Current = "[.\-\d\w]+";|Current = "{{ version }}";|' src/Stripe.net/Constants/Version.cs |