Skip to content

Commit afa9c28

Browse files
Add GitHub Actions instructions for fetching Intility NuGet package
1 parent bacdc8c commit afa9c28

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,21 @@ dotnet add package Intility.JsonApiToolkit
5252
3. **Configuration:**
5353
The toolkit automatically configures JSON serialization settings (camelCase properties, ignoring nulls, etc.) and adds the JSON:API media type to the supported output formatters.
5454

55+
## GitHub Actions
56+
To get fetch the package in your GitHub Actions workflow, add the following to your workflow file:
57+
58+
```yaml
59+
- name: Add Intility NuGet Package Source
60+
run: |
61+
dotnet nuget add source https://nuget.pkg.github.com/Intility/index.json \
62+
--name Intility \
63+
--username ${{ github.actor }} \
64+
--password ${{ secrets.GITHUB_TOKEN }} \
65+
--store-password-in-clear-text
66+
```
67+
68+
> [!IMPORTANT]
69+
> Your Github token must have the `read:packages` scope to access the package.
5570

5671
## Endpoint Example
5772

docs/docs/getting-started.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,19 @@ dotnet add package Intility.JsonApiToolkit
5757
> [!NOTE]
5858
> Now your API is ready to return responses that fully comply with the JSON:API specification!
5959
60+
61+
## GitHub Actions
62+
To get fetch the package in your GitHub Actions workflow, add the following to your workflow file:
63+
64+
```yaml
65+
- name: Add Intility NuGet Package Source
66+
run: |
67+
dotnet nuget add source https://nuget.pkg.github.com/Intility/index.json \
68+
--name Intility \
69+
--username ${{ github.actor }} \
70+
--password ${{ secrets.GITHUB_TOKEN }} \
71+
--store-password-in-clear-text
72+
```
73+
74+
> [!IMPORTANT]
75+
> Your Github token must have the `read:packages` scope to access the package.

0 commit comments

Comments
 (0)