-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* enable gh actions * fix yaml * fix markdown * remove travis config * change duplicated headline in readme * Only build test project with 5.0 * remove traces of travis ci * include release Co-authored-by: Santiago Traversa <[email protected]>
- Loading branch information
Showing
8 changed files
with
109 additions
and
58 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,13 @@ | ||
--- | ||
version: 2 | ||
updates: | ||
- package-ecosystem: nuget | ||
directory: / | ||
schedule: | ||
interval: daily | ||
time: '12:00' | ||
open-pull-requests-limit: 10 | ||
labels: | ||
- task | ||
- dependencies | ||
- backlog-dependencies | ||
- package-ecosystem: nuget | ||
directory: / | ||
schedule: | ||
interval: daily | ||
time: '12:00' | ||
open-pull-requests-limit: 10 | ||
labels: | ||
- task | ||
- dependencies | ||
- backlog-dependencies |
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,78 @@ | ||
--- | ||
name: ci | ||
|
||
"on": | ||
pull_request: | ||
push: | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
jobs: | ||
markdownlint-cli: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout Code | ||
uses: actions/checkout@v2 | ||
- name: Run markdownlint-cli | ||
uses: nosborn/[email protected] | ||
with: | ||
files: . | ||
config_file: ".markdownlint.yaml" | ||
|
||
yamllint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout Code | ||
uses: actions/checkout@v2 | ||
- name: Run YAML Lint | ||
uses: actionshub/yamllint@main | ||
|
||
build: | ||
needs: [markdownlint-cli, yamllint] | ||
runs-on: ubuntu-latest | ||
name: .NET ${{ matrix.dotnet-version }} | ||
strategy: | ||
matrix: | ||
dotnet-version: | ||
- '5.0.x' | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Setup dotnet ${{ matrix.dotnet-version }} | ||
uses: actions/setup-dotnet@v1 | ||
with: | ||
dotnet-version: ${{ matrix.dotnet-version }} | ||
- name: Display dotnet version | ||
run: dotnet --version | ||
- name: Restore dependencies | ||
run: dotnet restore | ||
- name: Build | ||
run: dotnet build --no-restore | ||
- name: Test | ||
run: dotnet test --no-build --verbosity normal | ||
|
||
release: | ||
name: Release | ||
if: startsWith(github.ref, 'refs/tags/') | ||
needs: | ||
- build | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Set VERSION variable from tag | ||
run: echo "VERSION=${GITHUB_REF/refs\/tags\/v/}" >> $GITHUB_ENV | ||
- name: Pack | ||
run: dotnet pack /p:PackageVersion=${VERSION} | ||
|
||
slack-workflow-status: | ||
if: always() | ||
name: Post Workflow Status To Slack | ||
needs: | ||
- build | ||
- release | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Slack Workflow Notification | ||
uses: Gamesight/slack-workflow-status@master | ||
with: | ||
repo_token: ${{secrets.GITHUB_TOKEN}} | ||
slack_webhook_url: ${{secrets.SLACK_WEBHOOK_URL_DEVELOPMENT}} |
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,3 @@ | ||
--- | ||
default: true | ||
line-length: false |
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
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,28 +1,29 @@ | ||
# Contributing to DNSimple/C# | ||
# Contributing to DNSimple/C\# | ||
|
||
## Getting Started | ||
|
||
#### 1. Clone the repository | ||
### 1. Clone the repository | ||
|
||
Clone the repository and move into it: | ||
|
||
```shell | ||
git clone [email protected]:dnsimple/dnsimple-csharp.git | ||
cd dnsimple-csharp | ||
``` | ||
|
||
#### 2. Install dependencies | ||
### 2. Install dependencies | ||
|
||
- .NET Core SDK | ||
|
||
From https://dotnet.microsoft.com/download/ | ||
From [https://dotnet.microsoft.com/download/](https://dotnet.microsoft.com/download/) | ||
|
||
You can either use to install the .NET Core SDK | ||
- Installers | ||
- Binaries | ||
- [Scripts](https://dotnet.microsoft.com/download/dotnet/scripts) | ||
- Install [Visual Studio](https://visualstudio.microsoft.com/) | ||
|
||
#### 3. Build and test | ||
### 3. Build and test | ||
|
||
[Run the test suite](#testing) to check everything is working as expected and to install the project specific | ||
dependencies (the first time you'll run the script it will install all the dependencies for you). | ||
|
@@ -41,21 +42,28 @@ The following instructions uses $VERSION as a placeholder, where $VERSION is a M | |
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 | ||
``` | ||
|
||
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 | ||
``` | ||
|
||
1. Create the NuGet Package | ||
|
||
```shell | ||
dotnet pack /p:PackageVersion=$VERSION -c Release | ||
``` | ||
|
||
1. Upload the package to [NuGet](https://www.nuget.org/) by using the web interface or pushing the package | ||
|
||
```shell | ||
dotnet nuget push ./src/dnsimple/bin/Release/DNSimple.$VERSION.nupkg -k <TOKEN> -s https://api.nuget.org/v3/index.json | ||
``` | ||
|
@@ -64,4 +72,4 @@ The following instructions uses $VERSION as a placeholder, where $VERSION is a M | |
|
||
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). | ||
When you submit a PR, tests will also be run on the [continuous integration environment via GitHub Actions](https://github.com/dnsimple/dnsimple-csharp/actions). |
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