I moved my weblog from WordPress to GitLab Pages in… 2016. I am pleased with the answer. Nonetheless, I used GitHub Pages after I was educating for each the programs and the workouts, e.g., Java EE. On the time, there was no GitHub Actions: I used Travis CI to construct and deploy.
Lately, I had to make use of GitHub Pages to publish my Apache APISIX workshop. Travis is not free. GitHub Actions are a factor. I used the now nominal path and confronted a number of hurdles; listed below are my findings.
GitHub Pages, on the Time
The earlier utilization of GitHub Pages was fairly simple. You pushed to a selected department, gh-pages. GitHub Pages rendered the basis of the department as a web site.
Travis works by watching a .travis.yml construct file on the repository root. When it detects a change, it runs it. I designed the script to construct HTML from Asciidoc sources and push it to the department. This is the numerous bit:
after_success:
# - ...
- git push --force --quiet "https://${GH_TOKEN}@${GH_REF}" grasp:gh-pages > /dev/null 2>&1GitHub Pages Now
Once you allow GitHub Pages, you’ll be able to select its supply: GitHub Actions or Deploy from a department. I used a workflow to generate HTML from Asciidoctor, and my mistake was choosing the primary selection.
GitHub Pages From a Department
Should you select Deploy from a department, you’ll be able to choose the department title and the supply root folder. Other than that, the habits is just like the pre-GitHub Motion habits. An enormous distinction, nevertheless, is that GitHub runs a GitHub Motion after every push to the department, whether or not the push occurs through an Motion or not.
When you can see the workflow executions, you can not entry its YAML supply. By default, the construct job within the workflow runs the next phases:
- Arrange job
- Pull the Jekyll construct web page Motion
- Checkout
- Construct with Jekyll
- Add artifact
- Submit Checkout
- Full job
Certainly, whether or not you need it or not, GitHub Pages builds for Jekyll! I do not need it as a result of I generate HTML from Asciidoc. To stop Jekyll construct, you’ll be able to put a .nojekyll file on the root of the Pages department. With it, the phases are:
- Arrange job
- Checkout
- Add artifact
- Submit Checkout
- Full job
No extra Jekyll!
GitHub Pages From Actions
The pages-build-deployment Motion above creates a tar.gz archive and uploads it to the Pages web site. The choice is to deploy your self utilizing a customized GitHub workflow. The GitHub Market presents Actions that will help you with it:
The documentation does a superb job of explaining the right way to use them throughout your customized workflow.
Conclusion
Deploying to GitHub Pages presents two choices: both from a department or from a customized workflow. Within the first case, you solely must push to the configured department; GitHub will deal with the inner mechanics to make it work through a offered workflow. You do not want to concentrate to the logs. The choice is to create your customized workflow and assemble the offered GitHub Actions.
As soon as I understood the choices, I made the primary one work. It is adequate for me, and I needn’t care about GitHub Pages’ inner workings.