JasonEtco / activity-box

βš‘οΈπŸ“Œ Update a pinned gist to contain the latest activity of a user

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

activity-box

βš‘οΈπŸ“Œ Update a pinned gist to contain the latest activity of a user

GitHub Actions status Codecov


Setup

activity-box is a GitHub Action that is designed to work using the schedule event.

Prep work

  1. Create a new public GitHub Gist (https://gist.github.com/)
  2. Create a token with the gist scope and copy it. The GITHUB_TOKEN that comes with GitHub Actions cannot currently use the Gist API.

Project setup

  1. Create a template repository by clicking here. Alternatively, you can click the Use this template button:
Screenshot of the GitHub repository UI, with the Use this template button highlighted

Name your repository and click Create repository from template.

Screenshot of the GitHub repository creation UI
  1. Create a .github/workflows/activity-box.yml file with a workflow like this:
name: Activity Box

on:
  schedule:
    - cron: '*/10 * * * *'

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v1
      - uses: JasonEtco/activity-box@master
        env:
          GH_PAT: ${{ secrets.GH_PAT }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GH_USERNAME: JasonEtco
          GIST_ID: 123abc
  1. Create a secret πŸ”‘ by going to GitHub repo > Settings > Secrets > New secret with the following:
  • Name: GH_PAT.
  • Value: The token with the gist scope generated previously.
  1. πŸ’° Profit

Environment variables & secrets

  • GIST_ID: The ID portion from your gist url https://gist.github.com/matchai/6d5f84419863089a167387da62dd7081.
  • GH_PAT: The GitHub token generated above.
  • GH_USERNAME: The username handle of the GitHub account.

Inspired by matchai/bird-box

About

βš‘οΈπŸ“Œ Update a pinned gist to contain the latest activity of a user

License:ISC License


Languages

Language:JavaScript 86.3%Language:Dockerfile 13.7%