Skip to content

Commit

Permalink
updated readme / GH action
Browse files Browse the repository at this point in the history
  • Loading branch information
SchlenkR authored and SchlenkR committed Sep 26, 2024
1 parent 8b32939 commit b598fa3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build-and-publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ jobs:
run: dotnet build -c Release

- name: Build docu
shell: pwsh
run: ./docu.ps1
run: ./docu.sh
shell: bash

- name: Upload docs artifact to GH pages
uses: actions/upload-pages-artifact@v3
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,14 @@ You need to have a recent .NET SDK installed, which is specified in `./global.js

There is a F# build script (`./build.fsx`) that can be used to perform several build tasks from command line.

For common tasks, there are powershell files located in the repo root:
For common tasks, there are bash scripts located in the repo root:

* `./test.ps1`: Runs all tests (sources in `./src/Tests`).
* `./test.sh`: Runs all tests (sources in `./src/Tests`).
* You can pass args to this task. E.g. for executing only some tests:
`./test.ps1 --filter Name~'Response Decompression'`
* `./docu.ps1`: Rebuilds the FsHttp documentation site (sources in `./src/docs`).
* `./docu-watch.ps1`: Run it if you are working on the documentation sources, and want to see the result in a browser.
* `./publish.ps1`: Publishes all packages (FsHttp and it's integration packages for Newtonsoft and FSharp.Data) to NuGet.
`./test.sh --filter Name~'Response Decompression'`
* `./docu.sh`: Rebuilds the FsHttp documentation site (sources in `./src/docs`).
* `./docu-watch.sh`: Run it if you are working on the documentation sources, and want to see the result in a browser.
* `./publish.sh`: Publishes all packages (FsHttp and it's integration packages for Newtonsoft and FSharp.Data) to NuGet.
* Always have a look at `./src/Directory.Build.props` and keep the file up-to-date.

## Credits
Expand Down

0 comments on commit b598fa3

Please sign in to comment.