planetoftheweb/podcast-generator

Generates podcast feeds using YAML, hosted by GitHub pages.

Podcast Feed Generator

A GitHub action to generate a podcast feed from a YAML file. YAML is much easier to read and write than XML, and this action will convert your YAML file into a valid podcast feed.

Usage

Turn on Github Pages

In your repository, go to Settings > Pages and select the main branch as the source. This will create a link to your page and give all of the content in the main branch a URL. Note the URL for the next step.

Create a YAML file

Create a YAML file in your repository with the following format:

title: <Podcast Title>
subtitle: <Podcast Subtitle>
author: <Author Name>
description: <Podcast Description>
link: <GitHub Pages URL>
image: <Artwork Location>
language: <Podcast Language e.g. en-us>
category: <Postcast Category e.g. Technology https://podcasters.apple.com/support/1691-apple-podcasts-categories>
format: <format of files e.g. audio/mpeg>
item:
  - title: <Podcast Episode Title>
    description: <Podcast Episode Description>
    published: <Date Published - e.g. Thu, 12 Jan 2023 18:00:00 GMT>
    file: <Filename e.g. /audio/TFIT01.mp3>
    duration: <duration e.g. 00:00:36>
    length: <length e.g. 576,324 (Get Info on your files)>
  ... Repeat for each episode

Sample Workflow

You're also going to need your own workflow file. Here's a sample:

name: Generate Feed
on: [push]
jobs:
  generate-feed:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v3
      - name: Run Feed Generator
        uses: planetoftheweb/podcast-feed-generator@main

podcast-generator's Issues

Is this explicitly for use with iTunes or is it intended to work with Spotify, Google, etc...?

Happy to add a PR to the README that clarifies this.

Dockerfile generates error

As Dhylan correctly states in the course - the Dockerfile needs correction:

Dockerfile:
apt-get install -y python3-yaml instead of pip3 install PyYAML

corrected version can look like this...

FROM ubuntu:latest

# Update apt-get and install necessary packages
RUN apt-get update && apt-get install -y \
    python3.12 \
    python3-pip \
    git \
    python3-yaml

# RUN pip3 install PyYAML     --> which generates the error 1 and fails the build.

# Copy feed.py file to the Docker image
COPY feed.py /usr/bin/feed.py

# Copy entrypoint.sh file to the Docker image
COPY entrypoint.sh /entrypoint.sh

# Set the entrypoint for the Docker image
ENTRYPOINT ["/entrypoint.sh"]