Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xoofx committed Feb 27, 2022
1 parent c467926 commit 4e82273
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 6 deletions.
14 changes: 11 additions & 3 deletions doc/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,12 +151,14 @@ You can easily replace all the steps used to build, tests, cover, pack and publi

In order to use `dotnet-releaser` on your GitHub CI, you need:

1. To install `dotnet 6.0`
2. To install the global tool `dotnet-releaser`
1. Checkout your repository with the correct settings with [actions/checkout](https://github.com/actions/checkout)
- Verify that you are using `v2` and by setting the property `fetch-depth: 0` to get all previous tags. See example below.
2. To install `dotnet 6.0`
3. To install the global tool `dotnet-releaser`
```sh
dotnet tool install --global dotnet-releaser
```
3. To run the dotnet-releaser command assuming that you have added all the secret tokens to your GitHub repository
4. To run the dotnet-releaser command assuming that you have added all the secret tokens to your GitHub repository
```sh
dotnet-releaser run --nuget-token ${{secrets.NUGET_TOKEN}} --github-token ${{secrets.GITHUB_TOKEN}} src/dotnet-releaser.toml
```
Expand All @@ -173,6 +175,12 @@ Depending on the kind of GitHub event, the run command will automatically:
An example of a setup with GitHub Actions:

```yaml
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Install .NET 6.0
uses: actions/setup-dotnet@v1
with:
Expand Down
Binary file added img/banner.pdn
Binary file not shown.
Binary file modified img/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 26 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,26 @@ By default, `dotnet-releaser` will:
```
dotnet-releaser build --force dotnet-releaser.toml
```
- If you want to integrate it to GitHub Action, use the `dotnet-releaser run` command. More details in the doc _[Adding dotnet-releaser to your CI on GitHub](https://github.com/xoofx/dotnet-releaser/tree/main/doc#12-adding-dotnet-releaser-to-your-ci-on-github)_
- If you want to integrate it to GitHub Action, use the `dotnet-releaser run` command. More details in the doc _[Adding dotnet-releaser to your CI on GitHub](https://github.com/xoofx/dotnet-releaser/tree/main/doc#12-adding-dotnet-releaser-to-your-ci-on-github)_. It is no more complicated than adding the following lines in your GitHub workflow file:
```yaml
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Install .NET 6.0
uses: actions/setup-dotnet@v1
with:
dotnet-version: '6.0.x'

- name: Build, Tests, Cover, Pack and Publish (on push tag)
run: |
dotnet tool install --global dotnet-releaser
dotnet-releaser run --nuget-token ${{secrets.NUGET_TOKEN}} --github-token ${{secrets.GITHUB_TOKEN}} src/dotnet-releaser.toml
```
See the user guide below for further details on how to use `dotnet-releaser`.

Expand All @@ -85,10 +104,14 @@ This software is released under the [BSD-Clause 2 license](https://opensource.or

## Who is using `dotnet-releaser`?

It's brand new, so only the author for now! :D
It's brand new, so it's mainly used by the author for now! :innocent:

You can see it's usage on the project [grpc-curl here](https://github.com/xoofx/grpc-curl/releases/tag/1.3.2).
You can visit the `.github/workflows` folder, or check the release notes of the following projects to see `dotnet-releaser` in action:

- [grpc-curl](https://github.com/xoofx/grpc-curl): An application shipping multiple executables
- [Scriban](https://github.com/scriban/scriban): A regular .NET library
- [Tomlyn](https://github.com/xoofx/Tomlyn): A regular .NET library
- [Zio](https://github.com/xoofx/zio): A regular .NET library
## Credits

`dotnet-releaser` is a wrapper around many amazing OSS libraries:
Expand Down

0 comments on commit 4e82273

Please sign in to comment.