https://github.com/qwreey/activity-box
https://github.com/qwreey/activity-box
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/qwreey/activity-box
- Owner: qwreey
- License: isc
- Created: 2022-01-19T14:57:15.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-19T15:11:46.000Z (over 4 years ago)
- Last Synced: 2025-01-30T00:32:09.207Z (over 1 year ago)
- Language: JavaScript
- Size: 131 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
activity-box
⚡️📌 Update a pinned gist to contain the latest activity of a user
---
## Setup
**activity-box** is a GitHub Action that is designed to work using the [`schedule`](https://developer.github.com/actions/managing-workflows/creating-and-cancelling-a-workflow/#scheduling-a-workflow) event.
### Prep work
1. Create a new public GitHub Gist (https://gist.github.com/)
2. [Create a token](https://github.com/settings/tokens/new) 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](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) by clicking [here](https://github.com/JasonEtco/activity-box/generate). Alternatively, you can click the _Use this template_ button:
| 
|
| --- |
Name your repository and click _Create repository from template_.
| 
|
| --- |
2. Create a `.github/workflows/activity-box.yml` file with a workflow like this:
```yml
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
```
3. [Create a secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) 🔑 by going to **GitHub repo > Settings > Secrets > New secret** with the following:
- Name: `GH_PAT`.
- Value: The token with the `gist` scope generated previously.
4. 💰 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](https://github.com/matchai/bird-box)_