-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add CI to Build and Publish and Update Documentation #5
Conversation
…pp with more examples
# GitHub Packages Feed settings | ||
GITHUB_FEED: https://nuget.pkg.github.com/giraffe-fsharp/ | ||
GITHUB_USER: dustinmoris | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👀
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe it would be beneficial to publish it in the same feed as the other Giraffe packages, but I am open to other suggestions as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's just wait for other people to review the PR too.
# Giraffe.OpenApi | ||
|
||
> [!IMPORTANT] | ||
> This is currently only works with my branch of Giraffe, which can be found [here](https://github.com/mrtz-j/Giraffe/tree/configureEndpoint). | ||
An extension for the [Giraffe](https://github.com/giraffe-fsharp/Giraffe) Web Application framework with functionality to auto generate OpenApi documentation spec from code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great README!
Add the `Giraffe.OpenApi` NuGet package to your project: | ||
|
||
```bash | ||
dotnet add package Giraffe.OpenApi |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR looks great.
Is there any chance to merge this and publish a Nuget package version of Giraffe.OpenApi
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, I'm just waiting for another maintainer to approve the PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, sorry I was on holiday. Skimmed over it, looks good from afar.
We can always revisit things later if needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this great contribution!
I'll update the restore-targets and try again in another PR 👍 |
I believe some yaml tweak is required before publishing will start to work. |
Description
This PR makes some additions and updates to the library. It adds GitHub Actions to the build and publish process, updates the README with proper documentation, and adds more examples to the
SampleApp
.It uses the available NuGet ENV-variables to publish it on NuGet under the name
Giraffe.OpenApi
.