Podcast microsite build and deployment using GitHub Pages and Actions

[mcleo-d]

Description

The following files and updates have been applied to the repo to build and deploy the lp-podcast project using GitHub actions and pages.

Deployment Action

.github/workflows/deploy.yml

When a pull request is merged to the main branch or someone pushes to the main branch directly, it will be built and deployed to the gh-pages branch. After that, the new build output will be served on the GitHub Pages site. This job is called deploy.

Test Build Action

.github/workflows/test-deploy.yml

When a new pull request is made to main, the action ensures the site builds successfully, without actually deploying. This job is called test-deploy.

Docusaurus Configuration

The following attributes have been added to specify the url, projectName,organizationName, deploymentBranch, and trailingSlash config of the microsite.

website/docusaurus.config.js

module.exports = { 
  url: 'https://linuxfoundation.github.io/lf-podcast',
  baseUrl: '/',
  projectName: 'lf-podcast',
  organizationName: 'linuxfoundation',
  deploymentBranch: 'gh-pages',
  trailingSlash: false,

Disable Jekyll Parsing

website/static/.nojekyll

By default, GitHub Pages runs published files through Jekyll. Since Jekyll will discard any files that begin with _, it is recommended that you disable Jekyll by adding an empty file named .nojekyll file to your static directory.