You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "entvex (via GitHub)" <gi...@apache.org> on 2024/01/19 12:38:03 UTC
[PR] Web api [pulsar-dotpulsar]
entvex opened a new pull request, #201:
URL: https://github.com/apache/pulsar-dotpulsar/pull/201
# Description
When we release a new version of DotPulsar we would like to build the web API and deploy it to GitHub pages.
Please see [wiki apache](https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features#Git.asf.yamlfeatures-GitHubPages) for the docs I used.
I am unsure if I have to create a branch called "gh-pages" or if Apache does that automatically changes to the .asf.yaml gets merged. Do you know @tisonkun ?
# Testing
Testing this workflow is challenging since GitHub doesn't offer a straightforward testing environment. I can't test it initially on a personal project. Because ASF are using a specific .asf.yaml that is not part of the normal GitHub workflow. But errors should not affect the "publish to nuget" operation, as the new job is only executed after that part has finished successfully. Unfortunately, due to GitHub's limitations, there are no comprehensive testing options available beyond these steps.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Web api [pulsar-dotpulsar]
Posted by "entvex (via GitHub)" <gi...@apache.org>.
entvex merged PR #201:
URL: https://github.com/apache/pulsar-dotpulsar/pull/201
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Web api [pulsar-dotpulsar]
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #201:
URL: https://github.com/apache/pulsar-dotpulsar/pull/201#discussion_r1459004040
##########
.github/workflows/publish-to-nuget.yml:
##########
@@ -56,4 +56,30 @@ jobs:
- name: Publish the package to nuget.org
run: dotnet nuget push src/DotPulsar/bin/Release/*.nupkg --api-key $NUGET_AUTH_TOKEN --source https://api.nuget.org/v3/index.json
env:
- NUGET_AUTH_TOKEN: ${{ secrets.NUGET_KEY }}
\ No newline at end of file
+ NUGET_AUTH_TOKEN: ${{ secrets.NUGET_KEY }}
+
+ build-web-api:
+ timeout-minutes: 120
+ needs: build
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Setup .NET
+ uses: actions/setup-dotnet@v3
+ with:
+ dotnet-version: '8.0.x'
+
+ - name: Build docs with docfx
+ run: |
+ dotnet tool update -g docfx
+ dotnet build -p:TargetFramework=net8.0
+ docfx docs/api/docfx.json
+
+ - name: Deploy to GitHub Pages
+ uses: peaceiris/actions-gh-pages@v3
Review Comment:
> if I have to create a branch called "gh-pages"
This action will push to such branch, while I don't remember if you should configure the branch name or the default is "gh-pages".
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Web api [pulsar-dotpulsar]
Posted by "entvex (via GitHub)" <gi...@apache.org>.
entvex commented on PR #201:
URL: https://github.com/apache/pulsar-dotpulsar/pull/201#issuecomment-1900444792
> We can merge and see if the deploy logic works well. I don't find issues but I don't try the GH pages feature for ASF projects before.
The new job will only execute after the “publish to NuGet” operation has run successfully. Therefore, it should be safe to merge. If the web API build and deploy fails, we can make changes and try again the next time a release runs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Web api [pulsar-dotpulsar]
Posted by "entvex (via GitHub)" <gi...@apache.org>.
entvex commented on code in PR #201:
URL: https://github.com/apache/pulsar-dotpulsar/pull/201#discussion_r1459007776
##########
.github/workflows/publish-to-nuget.yml:
##########
@@ -56,4 +56,30 @@ jobs:
- name: Publish the package to nuget.org
run: dotnet nuget push src/DotPulsar/bin/Release/*.nupkg --api-key $NUGET_AUTH_TOKEN --source https://api.nuget.org/v3/index.json
env:
- NUGET_AUTH_TOKEN: ${{ secrets.NUGET_KEY }}
\ No newline at end of file
+ NUGET_AUTH_TOKEN: ${{ secrets.NUGET_KEY }}
+
+ build-web-api:
+ timeout-minutes: 120
+ needs: build
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Setup .NET
+ uses: actions/setup-dotnet@v3
+ with:
+ dotnet-version: '8.0.x'
+
+ - name: Build docs with docfx
+ run: |
+ dotnet tool update -g docfx
+ dotnet build -p:TargetFramework=net8.0
+ docfx docs/api/docfx.json
+
+ - name: Deploy to GitHub Pages
+ uses: peaceiris/actions-gh-pages@v3
Review Comment:
I am pretty sure the default is gh-pages :)
[docs](https://github.com/peaceiris/actions-gh-pages)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Web api [pulsar-dotpulsar]
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #201:
URL: https://github.com/apache/pulsar-dotpulsar/pull/201#discussion_r1459010984
##########
.asf.yaml:
##########
@@ -48,4 +50,4 @@ notifications:
issues: commits@pulsar.apache.org
pullrequests: commits@pulsar.apache.org
discussions: dev@pulsar.apache.org
- jira_options: link label
+ jira_options: link label
Review Comment:
```suggestion
```
Somehow we don't activatie the JIRA project. If we touch these lines, let's remove it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org