https://github.com/maolonglong/actions-starcharts

自动生成星图（stars 趋势）的 action
https://github.com/maolonglong/actions-starcharts

actions chart docker generator github-api github-api-v4 go golang graphql spider visualization

Last synced: 2 months ago
JSON representation

自动生成星图（stars 趋势）的 action

• Host: GitHub
• URL: https://github.com/maolonglong/actions-starcharts
• Owner: maolonglong
• License: mit
• Created: 2021-09-29T10:38:25.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-10T05:59:03.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T10:47:25.154Z (2 months ago)
• Topics: actions, chart, docker, generator, github-api, github-api-v4, go, golang, graphql, spider, visualization
• Language: Go
• Homepage:
• Size: 1.35 MB
• Stars: 23
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Starcharts Action


灵感来自 [caarlos0/starcharts](https://github.com/caarlos0/starcharts)，用 Actions 避免了 [GitHub API 的速率限制](https://github.com/caarlos0/starcharts/issues/125)

## 入参

|       参数       |             描述              | 是否必传 |                 默认值                 |

| :--------------: | :---------------------------: | :------: | :------------------------------------: |

|  `github_token`  |  用于提交时身份验证的 token   |    是    |                                        |

|    `svg_path`    |        星图的保存路径         |    否    |           `"STARCHARTS.svg"`           |

| `commit_message` |           提交信息            |    否    | `"chore: update starcharts [skip ci]"` |

|  `stars_change`  | 更新至少需要的 stars 数变化值 |    否    |                 `"1"`                  |

|      `repo`      |      生成其他仓库的星图       |    否    |                  `""`                  |

## 示例

新建 **.github/workflows/starcharts.yml**，内容如下：

```yml

name: Starcharts

on:

  schedule:

    - cron: "0 0 * * 0"

  workflow_dispatch:

jobs:

  starcharts:

    name: Generate starcharts

    runs-on: ubuntu-latest

    steps:

      - uses: MaoLongLong/actions-starcharts@main

        with:

          github_token: ${{ secrets.GITHUB_TOKEN }}

          # 自定义 token 减少被限流的可能

          # github_token: ${{ secrets.GH_TOKEN }}

          svg_path: images/starcharts.svg

          # stars_change: "100"

          # repo: "doocs/advanced-java"

```

## 效果

[doocs/advanced-java](https://github.com/doocs/advanced-java) Stars 趋势

![](./images/starcharts.svg)

[doocs/leetcode](https://github.com/doocs/leetcode) Stars 趋势（2021-09-30 生成）

![](./images/doocs_leetcode_2021_09_30.svg)

## TODO

- [x] 修复由于 GitHub V3 API 分页限制，无法获取 40K stars 以上数据的问题

- [x] ~~部分操作仍然依赖 GitHub API V3，打算全部替换为 V4~~ 还是 v3 用的顺手点，所以暂时就 `getStargazers()` 用的 v4

- [x] ~~由于 Actions 中调用 V4 API 有 1000 的次数限制，所以它暂时只支持到 100K stars 的仓库~~ 用[自定义 token](https://github.com/settings/tokens/new?scopes=repo&description=starcharts)解决

- [ ] 为了文明使用 GitHub API，暂时没有使用多 goroutine，所以生成速度较慢