Skip to content

Commit

Permalink
Updates documentation and project files for v0.10.0 release (#43)
Browse files Browse the repository at this point in the history
* Removes nuspec description file

* Updates documentation

* Removed unneeded Cake build files

Co-Authored-By: Stephen Nelson <[email protected]>

* Update copyright dates, clean xml

* Remove deprecated project configuration

* Build tagged branches using tag as version

* Improve Travis Builds (#44)

* Use build matrix for target frameworks

* Use the dotnet matrix expansion

* Add solution file for matrix expansion

* Parallell jobs in test stage

* Move all tests to test stage

Co-authored-by: Stephen Nelson <[email protected]>
Co-authored-by: Stephen Nelson <[email protected]>
  • Loading branch information
3 people authored Apr 1, 2021
1 parent 9f808e2 commit 99144b3
Show file tree
Hide file tree
Showing 12 changed files with 54 additions and 489 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/.idea/
/.vscode/
/bin/
/packages/
/tools/
Expand Down
27 changes: 20 additions & 7 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
dist: bionic
dist: focal

language: csharp
mono: none
dotnet:
- 3.1.11
solution: dnsimple-csharp.sln
script:
- dotnet restore
- dotnet test
dotnet: 5.0

before_install: sudo apt-get install dotnet-sdk-3.1

jobs:
include:
- stage: test
script:
- dotnet restore
- dotnet test -f netcoreapp3.1
- dotnet test -f net50
- stage: release
if: branch = main AND tag IS present AND tag =~ /^\d{1,4}.\d{1,4}.\d{1,4}/ AND type = push
script:
- dotnet pack /p:PackageVersion=$TRAVIS_TAG

notifications:
email: false
38 changes: 13 additions & 25 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,51 +29,39 @@ dependencies (the first time you'll run the script it will install all the depen

To run the test suite:

- macOS / *NIX
```shell
./build.sh
```
- Windows
```shell
PS> .\build.ps1
```
```shell
dotnet test
```

## Releasing

The following instructions uses `$VERSION` as a placeholder, where `$VERSION` is a `MAJOR.MINOR.BUGFIX` release such as `1.2.0`.
The following instructions uses $VERSION as a placeholder, where $VERSION is a MAJOR.MINOR.BUGFIX release such as 1.2.0.

1. Run the test suite and ensure all the tests pass.
2. Set the version in `AssemblyInfo.cs` (located in `./src/dnsimple/Properties`).
```c#
[assembly: AssemblyVersion("$VERSION")]
[assembly: AssemblyFileVersion("$VERSION")]
```
3. Run the test suite and ensure all tests pass (`./build.sh`).
4. Finalize the `## main` section in `CHANGELOG.md` assigning the version.
5. Commit and push the changes
1. Update `PackageReleaseNotes` in `dnsimple.csproj` (located in `./src/dnsimple`).
1. Finalize the `## main` section in `CHANGELOG.md` assigning the version.
1. Commit and push the changes
```shell
git commit -a -m "Release $VERSION"
git push origin main
```
6. Wait for the CI to complete.
7. Create a signed tag.
1. Wait for the CI to complete.
1. Create a signed tag.
```shell
git tag -a v$VERSION -s -m "Release $VERSION"
git push origin --tags
```
8. Create the NuGet Package
1. Create the NuGet Package
```shell
./build.sh --target=Package
dotnet pack /p:PackageVersion=$VERSION
```

9. Upload the package to [NuGet](https://www.nuget.org/) by using the web interface or pushing the package
1. Upload the package to [NuGet](https://www.nuget.org/) by using the web interface or pushing the package
```shell
nuget push <path/to/file.nupkg>
dotnet nuget push <path/to/file.nupkg>
```

## Testing

Submit unit tests for your changes. You can test your changes on your machine by [running the test suite](#testing).

When you submit a PR, tests will also be run on the [continuous integration environment via Travis](https://travis-ci.com/dnsimple/dnsimple-csharp).

2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2020 DNSimple Corporation
Copyright (c) 2021 DNSimple Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,4 @@ We recommend to customize the user agent. If you are building a library or integ

## License

Copyright (c) 2020 DNSimple Corporation. This is Free Software distributed under the MIT license.
Copyright (c) 2021 DNSimple Corporation. This is Free Software distributed under the MIT license.
49 changes: 0 additions & 49 deletions build.cake

This file was deleted.

Loading

0 comments on commit 99144b3

Please sign in to comment.