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

Publish GitHub Page with GitHub Action #32

Merged
merged 1 commit into from
Aug 2, 2021
Merged

Conversation

focaaby
Copy link
Contributor

@focaaby focaaby commented Aug 1, 2021

Use #20 makefile

  1. Generate the HTML assets and deploy them to the GitHub Page[1].
  2. Publish the html directory as release HTML assets.

References:

  1. https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

@jserv
Copy link
Contributor

jserv commented Aug 2, 2021

Here is the demo URL: https://focaaby.github.io/lkmpg/index.html

TikZ graph was not rendered correctly. @fennecJ, can you give a hint?

@fennecJ
Copy link
Collaborator

fennecJ commented Aug 2, 2021

I tryied to use @focaaby 's action script, and my TikZ graph was not rendered correctly, either.
I have checked the version of the tool we used and don't find any problem currently.

As I mentioned in #27 , xu-cheng/texlive-action worked well and rendered the page correctly.
Consider switch to xu-cheng/texlive-action instead of texlive/texlive ?

@Hsins
Copy link
Contributor

Hsins commented Aug 2, 2021

Umm...

  • Workflows in GitHub Actions/GitLab CI/Azure Pipeline... are series of tasks running on the docker container.
  • Docker containers are instances of given docker image.

They are not the same thing. Switching from workflows to workflows is just switching the environments that other defined, why don't we just created the environment for us?

@fennecJ
Copy link
Collaborator

fennecJ commented Aug 2, 2021

@Hsins
Sorry I didn't notice that you have built up a docker image when I comment then.
And I tried your docker image, it worked well.
I agree that we should just create the environment for us.

Copy link
Contributor

@jserv jserv left a comment

Choose a reason for hiding this comment

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

Read this carefully: https://chris.beams.io/posts/git-commit/

  • Wrap the body at 72 characters

Don't use markdown syntax inside git commit message.

@jserv
Copy link
Contributor

jserv commented Aug 2, 2021

For the sake of naming consistency, rename .github/workflows/generate_pdf.yml to .github/workflows/generate_docs.yml which generates PDF and HTML accordingly.

@jserv
Copy link
Contributor

jserv commented Aug 2, 2021

The message is too long:

Add a new Github Action to publish to the GitHub page. Use https://github.com/TeXtw/docker-lkmpg image for reproducibility.

Wrap the body at 72 characters.

Add a new Github Action to publish to the GitHub page. Use twtug/lkmpg
image for reproducibility.

Ref:
- sysprog21#27
- https://github.com/TeXtw/docker-lkmpg
@focaaby focaaby requested a review from jserv August 2, 2021 05:32
@jserv jserv merged commit 859af5f into sysprog21:master Aug 2, 2021
@jserv
Copy link
Contributor

jserv commented Aug 2, 2021

Thank @focaaby for contributing!

@jserv
Copy link
Contributor

jserv commented Aug 2, 2021

I was not aware of the HTML generation on GitHub Pages. Here are the configurations:
GitHub Pages

@focaaby, how should I make changes?

@fennecJ
Copy link
Collaborator

fennecJ commented Aug 2, 2021

For the sake of naming consistency, both 2 script files should be ended with .yml either .yaml .
According to yaml.org

Is there an official extension for YAML files?

Please use ".yaml" when possible.

It seems .yaml is better choise.

@fennecJ
Copy link
Collaborator

fennecJ commented Aug 2, 2021

@jserv
I can see the page in https://sysprog21.github.io/lkmpg now.
Maybe it's caused by cache?
Try using ctrl + F5 to refresh the page without cache.

@jserv
Copy link
Contributor

jserv commented Aug 2, 2021

I can see the page in https://sysprog21.github.io/lkmpg now.
Maybe it's caused by cache?

It works for me now. Thanks!

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