Skip to content
/ ics Public

GitEvents iCal Action to generate .ics files for calendar subscriptions

License

Notifications You must be signed in to change notification settings

gitevents/ics

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

GitEvents ICS Generator

GitEvents ICS Generator is a GitHub Action to fetch and parse Issues and generate an iCalendar (.ics) file which can be hosted and shared for calendar subscriptions.

Features

  • 🤖 generate, commit and push an .ics file

Installation & Usage

name: GitEvents ICS Generator

on:
  issues:
    types: [labeled]
  schedule:
    - cron: '0 0 * * *'

jobs:
  generate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
      - name: GitEvents ICS Generator
        uses: gitevents/[email protected]
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          default-timezone: 'Europe/Athens'
          locations: 'locations.json'
      - uses: actions/checkout@v3
      - run: |
          git config user.name gitevents[bot]
          git config user.email [email protected]
          git add events.ics
          git commit -m "update calendar file"
          git push

Development

Local development and testing works with act.

    $ act
    $ act --list
    $ act workflow_dispatch

The github token can be stored in .secrets:

GITHUB_TOKEN=ghp_123xyz

Example locations.json file:

[
  {
    "id": "idea-cy",
    "name": "IDEA Cyprus, Nicosia",
    "city": "Nicosia",
    "geo": [35.172405, 33.36224]
  }
]

Known issues and TODOs

  • add xml/json/atom rss feed
  • add tests
  • recurring events
  • add more flexibility to date and time parser
  • parse markdown into plaintext and html for ics content
  • add error handling

License

Licensed under MIT.

Here is a list of all the licenses of our production dependencies

About

GitEvents iCal Action to generate .ics files for calendar subscriptions

Resources

License

Stars

Watchers

Forks