From 4a6d3383be7e878fa3d5909961ae0c32c8c38184 Mon Sep 17 00:00:00 2001 From: George Mandis Date: Tue, 4 Feb 2020 08:51:30 -0500 Subject: [PATCH] Updated README to explain GitHub Actions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 49f2a67..d70c691 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ The deploy settings should automatically import from the `netlify.toml` file. Al ### Keeping Feeds Updated +#### Using Netlify Webhooks + To keep your feeds up to date you'll want to [setup a Build Hook](https://www.netlify.com/docs/webhooks/#incoming-webhooks) for your Netlify site and use another service to ping it every so often to trigger a rebuild. I'd suggeste looking into: - [IFTTT](https://ifttt.com/) @@ -28,6 +30,16 @@ To keep your feeds up to date you'll want to [setup a Build Hook](https://www.ne If you already have a server running Linux and some command-line experience it might be simpler to setup a [cron job](https://en.wikipedia.org/wiki/Cron). +#### Using GitHub Actions + +This approach is a little different and requires some modifications to the repository. Netlify started billing for [build minutes](https://www.netlify.com/pricing/faq/) very shortly after I published this project. Running `npm build` and downloading all of the RSS feeds took up a substantial number of this minutes, particulary if you had some kind of process pinging the webhook and trigger a build every 15 minutes or so. + +How is the The GitHub Action-based approach different? The same build process runs, but this time it's on GitHub's servers via the Action. It then **commits** the newly created file generated at `./output/index.html` back into the repository. Netlify still gets pinged when the repository is updated, but skips the `npm run build` step on their end, which significantly reduces the number of build minutes required. + +**Short Answer**: use the `github-action-publishing` branch for now if you'd prefer to use GitHub Actions to run your builds. + +The GitHub Action is setup to build and commit directly to the `master` branch, which is not the best practice. I'd suggest creating a separate branch to checkout and commit changes to in the Action. You could then specify that same branch as the one to checkout and publish on Netlify. + ## Anatomy of Bubo Reader - `src/index.html` - a [Nunjucks](https://mozilla.github.io/nunjucks/) template that lets you change how the feeds are displayed