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

Automatic documentation upload to gh-pages branch #25

Closed
hugopl opened this issue Apr 19, 2022 · 4 comments · Fixed by #32
Closed

Automatic documentation upload to gh-pages branch #25

hugopl opened this issue Apr 19, 2022 · 4 comments · Fixed by #32
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@hugopl
Copy link
Owner

hugopl commented Apr 19, 2022

Currently, the documentation at https://hugopl.github.io/gtk4.cr/ is made "manually", I mean... every time I need to update it I do:

git checkout gh-pages
git rm doc
git merge WHATEVER_NEW_VERSION
make doc
git add doc
git push origin gh-pages

These are simple and static steps that can be automatized by a github actions that runs every time a new tag is created in the repository.

@hugopl hugopl added help wanted Extra attention is needed good first issue Good for newcomers labels Apr 19, 2022
@1player
Copy link
Contributor

1player commented Apr 27, 2022

I started working on this on my local fork, mostly to familiarise myself with Github Actions, but the latest Ubuntu version they provide workers for is 20.04 LTS which doesn't ship with gtk4. I've read they'll have Ubuntu 22.04 LTS in preview state some time in May, so I guess this is on hold until then.

actions/runner-images#5428

@1player
Copy link
Contributor

1player commented May 5, 2022

Apparently Ubuntu 22.04 is now available: actions/runner-images#5490 so this is now possible. I'll have a jab at it next week.

@GeopJr
Copy link
Contributor

GeopJr commented May 13, 2022

I usually use peaceiris/actions-gh-pages for publishing docs since it handles a lot from checking whether anything actually changed to removing all commits from the branch so it doesn't clog cloning (and many more):

@1player
Copy link
Contributor

1player commented Jul 1, 2022

I'm working on it right now, I should have something ready soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants