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

Github Action should build and deploy api docs #814

Closed
fliiiix opened this issue Mar 16, 2022 · 5 comments
Closed

Github Action should build and deploy api docs #814

fliiiix opened this issue Mar 16, 2022 · 5 comments
Labels
docs Documentation of the project feature testing/ci Test coverage & GitHub actions etc.
Milestone

Comments

@fliiiix
Copy link
Contributor

fliiiix commented Mar 16, 2022

It would be cool to have a easy way to access the build api docs for each PR.
See: #810 (comment)

If someone wants to work on that just sign up here to do it, otherwise i will create a proposal for that when i find time :D.

@ix5 ix5 added feature docs Documentation of the project labels Mar 16, 2022
@ix5 ix5 added this to the 0.13 milestone Mar 16, 2022
@ix5
Copy link
Member

ix5 commented Mar 20, 2022

I've been in contact with @posativ about having docs auto-deploy instead of him uploading them whenever he finds the time.
Let's wait until he has some time to judge the proposal's merits and then potentially include the generated API docs.

@ix5
Copy link
Member

ix5 commented Mar 20, 2022

fwiw, I've created a branch with apidoc generation commands, maybe we can agree on those https://github.com/ix5/isso/tree/apidoc

@fliiiix
Copy link
Contributor Author

fliiiix commented Mar 21, 2022

But this does not upload the artefacts to somewhere and does not build on a pr right?

@ix5
Copy link
Member

ix5 commented Mar 21, 2022

But this does not upload the artefacts to somewhere and does not build on a pr right?

Yes, that branch was just an example as a starting point for you.

For auto-deployment, see e.g. https://github.com/SoMainline/docs.somainline.org/blob/9900033292e5cf54ae3ed73edfb43841c51ec84d/.github/workflows/publish.yml

@ix5 ix5 added the testing/ci Test coverage & GitHub actions etc. label Apr 23, 2022
@ix5 ix5 modified the milestones: 0.13, open-ended May 24, 2022
@ix5
Copy link
Member

ix5 commented Jan 27, 2024

The GitHub Action also deploys the API docs since b2a1c61

@ix5 ix5 closed this as completed Jan 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation of the project feature testing/ci Test coverage & GitHub actions etc.
Projects
None yet
Development

No branches or pull requests

2 participants