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 Github Action workflow to automate deployment of documentation #32

Merged
merged 3 commits into from
Jul 1, 2022

Conversation

1player
Copy link
Contributor

@1player 1player commented Jul 1, 2022

Fixes #25 and it is a good starting point for #24

@hugopl
Copy link
Owner

hugopl commented Jul 1, 2022

How does it works? it create commits on gh-pages branche?

@1player
Copy link
Contributor Author

1player commented Jul 1, 2022

Yes, it uses the peaceiris/actions-gh-pages@v3 action which seems to be the most used one. I've ran it on my repo, you can check the result here: 1player@bdb690a or 1player@a0f661d

(for some reason Github is having issues rendering that commit, just have a look at my gh-pages branch)

Basically that action recreates the docs directory from scratch and commits it, with the master commit it's referring to in the name. Pretty neat.

@hugopl hugopl merged commit c7db68b into hugopl:master Jul 1, 2022
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.

Automatic documentation upload to gh-pages branch
2 participants