Skip to content
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

Merged
merged 3 commits into from
Aug 5, 2024

Conversation

mrtz-j
Copy link
Contributor

@mrtz-j mrtz-j commented Jul 20, 2024

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.

@mrtz-j mrtz-j marked this pull request as ready for review July 20, 2024 13:50
Comment on lines +18 to +21
# GitHub Packages Feed settings
GITHUB_FEED: https://nuget.pkg.github.com/giraffe-fsharp/
GITHUB_USER: dustinmoris
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀

Copy link
Contributor Author

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.

@64J0 64J0 requested review from dbrattli and nojaf July 21, 2024 21:07
Copy link
Member

@64J0 64J0 left a 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.
Copy link
Member

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
Copy link

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?

Copy link
Member

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

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dbrattli @nojaf Can you please help?

Copy link
Contributor

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.

Copy link
Contributor

@nojaf nojaf left a 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!

@nojaf nojaf merged commit 710ffa4 into giraffe-fsharp:main Aug 5, 2024
@nojaf
Copy link
Contributor

nojaf commented Aug 5, 2024

Some leftover problem:

image

@mrtz-j
Copy link
Contributor Author

mrtz-j commented Aug 5, 2024

I'll update the restore-targets and try again in another PR 👍

@dungpa
Copy link

dungpa commented Aug 7, 2024

@mrtz-j @nojaf Is it possible to publish a NuGet package based on this PR?

@nojaf
Copy link
Contributor

nojaf commented Aug 7, 2024

I believe some yaml tweak is required before publishing will start to work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants