Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ism0080/comicstrip-readme
Simple GitHub Action that updates the public profile README with the most recent XKCD comic
https://github.com/ism0080/comicstrip-readme
docker gitmoji profile python workflow xkcd
Last synced: 8 days ago
JSON representation
Simple GitHub Action that updates the public profile README with the most recent XKCD comic
- Host: GitHub
- URL: https://github.com/ism0080/comicstrip-readme
- Owner: ism0080
- License: mit
- Created: 2020-10-07T04:02:23.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2020-10-07T05:09:54.000Z (about 4 years ago)
- Last Synced: 2024-09-16T23:06:28.244Z (2 months ago)
- Topics: docker, gitmoji, profile, python, workflow, xkcd
- Language: Python
- Homepage: https://github.com/marketplace/actions/comic-strip-readme
- Size: 11.7 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Comic Strip 
This GitHub Workflow updates your readme with the provided comic strips daily. The current comics available are:
- [XKCD](https://xkcd.com/)
## Update your README
Add a comment to your `README.md`:
```md
```
The images will appear between the comments
### Profile Repository
_If you're executing the workflow on your Profile Repository (`/`)_
> You wouldn't need an GitHub Access Token since GitHub Actions already makes one for you.
Follow the bellow steps:
1. Go to your `//actions`, hit `New workflow`, `set up a workflow yourself`, delete all the default content github made for you.
2. Copy the following code and paste it to your new workflow you created at step 1:
```yml
name: Comic Strip Readme
on:
workflow_dispatch:
schedule:
# Runs at 8am UTC every Monday, Wednesday, Friday
- cron: "0 8 * * 1,3,5"
jobs:
update-readme:
name: Update README with Comic Strip
runs-on: ubuntu-latest
steps:
- uses: ism0080/[email protected]
with:
SHOW_XKCD: true
```
This will add the XKCD comics to your `README.md` at 8am UTC every Monday, Wednesday and Friday
3. Add a comment to your `README.md` like this:
```md
```
4. Go to Workflows menu (mentioned in step 1), click `Comic Strip Readme`, click `Run workflow`.
5. Go to your profile page. you will be able to see it.
### Other Repository (not Profile)
_If you're executing the workflow on another repo other than `/`_
You'll need to get a [GitHub Access Token](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) with a `repo` scope and save it in the Repo Secrets `GH_TOKEN = `
Here is Sample Workflow File for running it:
```yml
name: Comic Strip Readme
on:
schedule:
# Runs at 8am UTC every Monday, Wednesday, Friday
- cron: "0 8 * * 1,3,5"
jobs:
update-readme:
name: Update README with Comic Strip
runs-on: ubuntu-latest
steps:
- uses: ism0080/[email protected]
with:
SHOW_XKCD: true
GH_TOKEN: ${{ secrets.GH_TOKEN }}
REPOSITORY: # optional, By default, it will automatically use the repository who's executing the workflow.
```
### Extras
1. You can specify a commit message to override the default _"Updated readme comic strip"_. Add `COMMIT_MESSAGE` with the commit message you want
```yml
with:
COMMIT_MESSAGE: Readme updated
```
_*NOTE: Sometimes the comic may not be new at the time of the cron job running*_