actions-hugo VS Oryx

You can build your Hugo site in your Github Actions, e.g. like in https://github.com/peaceiris/actions-hugo, then push the static pages to your server

Documentation provides an example workflow file that uses GitHub Actions for Hugo action in the "Build Hugo With GitHub Action" section. It is ok to use it, but I will use combination of 2 examples (1, 2) from GitHub Actions for Hugo's README because it has one for projects using PostCSS.

If the data fetch from previous step succeeds, the workflow continues by building the static website with Hugo. Hugo is setup using action peaceiris/actions-hugo. When the files are ready, the result is published to GitHub pages, using another GitHub action, peaceiris/actions-gh-pages.

Luckily, there is a workflow for it. By implementing peaceiris/actions-hugo@v2 on my GitHub workflow, I was able to achieve what I wanted to do. Simple as that.

Less is more IMO. A Github Action using Hugo to deploy to GH pages.

For more information about the actions used and their options, please see Hugo and Github pages on Github.

I am looking for someone who can help me, pro bono, to: - set up this site using GitHub Pages - set up Hugo SSG (https://gohugo.io) using Jane (https://github.com/xianmin/hugo-theme-jane) as the theme - set up automatic building using GitHub actions perhaps using https://github.com/peaceiris/actions-hugo - set up Giscus (https://giscus.app) for comments (may need to fork theme, if so try to up a steam a PR also so a separate fork does not need to be maintained.) - set up banner art and profile picture (may need to fork theme, if so try to up a steam a PR also so a separate fork does not need to be maintained.) - set up SEO, RSS, favicon, Analytics, etc.

View on GitHub

I set up Hugo with peaceiris/actions-hugo. The build step afterwards runs the command

``` App Directory Location: 'src' was found. Looking for event info Starting to build app with Oryx Azure Static Web Apps utilizes Oryx to build both static applications and Azure Functions. You can find more details on Oryx here: https://github.com/microsoft/Oryx ---Oryx build logs---

One of the things I like about Azure Static Web Apps is that they can build themselves. You can just push your code to GitHub and they'll build it using a tool called Oryx. This is great for simple scenarios. Actually, it's good for medium to complex scenarios too. However, if you ever get to that "break glass" moment where you need to do something unusual with your build, you can.

Azure uses a system called Oryx. You don't need to know too much about how it works but it looks for specific files and chooses build specs based on them. If you have a requirements.txt, Oryx will know to use Python. 1

4:48:55 pm ppdedsrftwu2-appservice1: Starting deployment...4:48:56 pm ppdedsrftwu2-appservice1: Creating zip package...4:49:00 pm ppdedsrftwu2-appservice1: Zip package size: 1.09 MB4:49:04 pm ppdedsrftwu2-appservice1: Fetching changes.4:49:06 pm ppdedsrftwu2-appservice1: Updating submodules.4:49:06 pm ppdedsrftwu2-appservice1: Preparing deployment for commit id '2a73dbd291'.4:49:06 pm ppdedsrftwu2-appservice1: Repository path is /tmp/zipdeploy/extracted4:49:06 pm ppdedsrftwu2-appservice1: Running oryx build...4:49:06 pm ppdedsrftwu2-appservice1: Command: oryx build /tmp/zipdeploy/extracted -o /home/site/wwwroot --platform nodejs --platform-version 10 -i /tmp/8d856447f426192 -p compress_node_modules=tar-gz --log-file /tmp/build-debug.log 4:49:07 pm ppdedsrftwu2-appservice1: Operation performed by Microsoft Oryx, https://github.com/Microsoft/Oryx4:49:07 pm ppdedsrftwu2-appservice1: You can report issues at https://github.com/Microsoft/Oryx/issues4:49:07 pm ppdedsrftwu2-appservice1: Oryx Version: 0.2.20200805.1, Commit: e7c39ede513143e9d80fd553f106f04268d770d4, ReleaseTagName: 20200805.14:49:07 pm ppdedsrftwu2-appservice1: Build Operation ID: |lvjLop9mFGA=.426fac1c_4:49:07 pm ppdedsrftwu2-appservice1: Repository Commit : 2a73dbd2834715ba1fee5082d13b604:49:07 pm ppdedsrftwu2-appservice1: Detecting platforms...4:49:07 pm ppdedsrftwu2-appservice1: Could not detect any platform in the source directory.4:49:07 pm ppdedsrftwu2-appservice1: Error: Couldn't detect a version for the platform 'nodejs' in the repo.4:49:09 pm ppdedsrftwu2-appservice1: Error: Couldn't detect a version for the platform 'nodejs' in the repo.\n/opt/Kudu/Scripts/starter.sh oryx build /tmp/zipdeploy/extracted -o /home/site/wwwroot --platform nodejs --platform-version 10 -i /tmp/8d856447f4292 -p compress_node_modules=tar-gz --log-file /tmp/build-debug.log 4:49:20 pm ppdedsrftwu2-appservice1: Deployment failed. Have defined all the necessary settings in the portal.

I need to add post-build actions to complete the deployment; the exceeding common Django task of running "manage.py". Following the general and python-specific docs I have added the an app setting of POST_BUILD_SCRIPT_PATH=postbuild.sh

What exactly StaticSitesClient does is shrouded with mystery, but upon successful build (using Oryx) it creates two zip files: app.zip and api.zip. Then it uploads both to Blob storage and submits a request for ContentDistribution endpoint to pick the assets up.

The GitHub Actions workflow, created in the project repository, does use the Azure Static Web Apps Deploy GitHub action from the marketplace. This reusable Action utilizes Oryx system to build both static applications and Azure Functions for API and then deploys it. You can find more information on Oryx repository at https://github.com/microsoft/Oryx and on how it does detect & build Hugo applications.