Skip to content

Commit

Permalink
Podcast microsite build and deployment using GitHub Pages and Actions (
Browse files Browse the repository at this point in the history
…#3)

* initial netlify test

Signed-off-by: James McLeod <james.mcleod@finos.org>

* Update team.mdx (#2)

Signed-off-by: SeniorStoryteller <66965127+SeniorStoryteller@users.noreply.github.com>
Signed-off-by: James McLeod <james.mcleod@finos.org>

* add gh-pages deploy config and actions

Signed-off-by: James McLeod <james.mcleod@finos.org>

* update config

Signed-off-by: James McLeod <james.mcleod@finos.org>

* update package.json

Signed-off-by: James McLeod <james.mcleod@finos.org>

* update action paths

Signed-off-by: James McLeod <james.mcleod@finos.org>

Co-authored-by: SeniorStoryteller <66965127+SeniorStoryteller@users.noreply.github.com>
  • Loading branch information
James McLeod and SeniorStoryteller authored Jun 15, 2022
1 parent e3709b3 commit b2fe556
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 7 deletions.
44 changes: 44 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

paths:
- "docs/**"
- "website/**"

jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 16.x
cache: yarn

- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build

# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
28 changes: 28 additions & 0 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Test deployment

on:
pull_request:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

paths:
- "docs/**"
- "website/**"

jobs:
test-deploy:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 16.x
cache: yarn

- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Test build website
run: yarn build
14 changes: 8 additions & 6 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,20 @@ const projectSlug = 'linux-foundation-podcast-project'
// Replace 'FINOS' with {name of copyright owner}
const copyrightOwner = 'The Linux Foundation'

module.exports = {
module.exports = {
title: `${projectName}`,
tagline: `${projectName}`,
url: 'https://finos.org',
url: 'https://linuxfoundation.github.io/',
baseUrl: '/',
favicon: 'img/favicon/cropped-favicon-80x80.png',
projectName: `${projectName}`,
organizationName: `${copyrightOwner}`,
projectName: 'lf-podcast',
organizationName: 'linuxfoundation',
trailingSlash: false,
customFields: {
repoUrl: `https://github.com/finos/${projectSlug}`,
deploymentBranch: 'gh-pages',
repoUrl: `https://github.com/linuxfoundation/lf-podcast`,
ctaButton: 'CONTRIBUTE YOUR LF PODCAST EPISODE',
ctaUrl: 'https://github.com/mcleo-d/lf-podcast',
ctaUrl: 'https://github.com/linuxfoundation/lf-podcast',
ctaHeader: 'Become part of the joined up Linux Foundation podcast network'
},
scripts: ['https://buttons.github.io/buttons.js'],
Expand Down
2 changes: 1 addition & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
"is-promise": "2.1.0",
"react-player": "^2.10.0"
}
}
}
Empty file added website/static/.nojekyll
Empty file.

0 comments on commit b2fe556

Please sign in to comment.