Skip to content

docs(readme): add GitHub Actions integration section with workflow example #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maurodesouza wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): add GitHub Actions integration section with workflow example #249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Please refer to the updated link [here](#how-to-use)
- [First Method](#first-method)
- [Second Method](#second-method)
- [Finally](#finally)
- [GitHub Actions](#github-actions)
- [Contributing](#contributing)
- [Core Team 💻](#core-team-)
- [Contributors ✨](#contributors-)
Expand Down Expand Up @@ -206,6 +207,55 @@ Now just add the following to your profile readme and you're good to go.

</details>

## GitHub Actions

GitHub Actions generates static SVGs and avoids per-request API calls. By default it uses GITHUB_TOKEN (public stats only), for private stats, set a TOKEN as a secret and pass it to the action instead.

Create `/.github/workflows/activity-graph.yml` in your profile repo (USERNAME/USERNAME):

```yaml
name: Update Activity Graph

on:
schedule: # execute every 12 hours
- cron: "* */12 * * *"
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest

permissions:
contents: write

steps:
- uses: actions/checkout@v6

- name: Generate activity graph
uses: maurodesouza/github-readme-activity-graph-action@v1
with:
username: ${{ github.repository_owner }}
options: theme=dracula&hide_border=true
output_path: dist/activity-graph.svg
token: ${{ secrets.GITHUB_TOKEN }}

- name: Push activity-graph.svg to the output branch
uses: crazy-max/ghaction-github-pages@v3.1.0
with:
target_branch: output
build_dir: dist
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

Then add the following to your profile readme:

```md
![Activity Graph](https://raw.githubusercontent.com/{owner}/{repo}/output/activity-graph.svg)
```

The action is available [here](https://github.com/maurodesouza/github-readme-activity-graph-action).

## Contributing

Please read through our [contributing guidelines](https://github.com/Ashutosh00710/github-readme-activity-graph/blob/main/CONTRIBUTING.md). Directions are included for opening issues, coding standards, and notes on development.
Expand Down