Gitartwork 使用教程

Gitartwork 使用教程

gitartwork Gitartwork on user's contribution graph 项目地址: https://gitcode.com/gh_mirrors/gi/gitartwork

1. 项目介绍

Gitartwork 是一个开源项目，它可以将用户的 GitHub 贡献图转换成 SVG 图片。此项目允许用户自定义图片上的文本，并将生成的图片推送到用户的 GitHub 仓库中，方便在 README 文件中展示个人或团队的贡献活动。

2. 项目快速启动

要使用 Gitartwork，请按照以下步骤操作：

首先，在你的 GitHub 仓库中创建一个新的 .github/workflows/gitartwork.yml 文件，并添加以下内容：

name: gitartwork from a contribution graph

on:
  push:

jobs:
  build:
    name: Make gitartwork SVG
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: jasineri/gitartwork@v1
      with:
        # 使用此处的用户名
        user_name: 你的GitHub用户名
        # 贡献图上的文本
        text: 自定义文本
    - uses: jasineri/simple-push-action@v1

确保在仓库的设置中启用了 Actions，并在 General 选项卡下设置了 Workflow permissions 为 Read and write。

提交并推送这个 .github/workflows/gitartwork.yml 文件到你的仓库后，GitHub Actions 将自动执行，生成一个 gitartwork.svg 文件，并将其推送到你的仓库。

然后，你可以在 README 文件中通过以下方式引用生成的 SVG 图片：

![gitartwork](gitartwork.svg)

3. 应用案例和最佳实践

• 个性化贡献图：通过自定义 text 参数，你可以在贡献图上添加个性化的文本，如团队名称或个人签名。
• 自动化集成：通过将 Gitartwork 集成到持续集成工作流程中，你可以确保每次提交都会自动更新贡献图。

4. 典型生态项目

Gitartwork 作为一个开源项目，可以与其他开源工具和平台结合使用，例如：

• GitHub Actions：自动化工作流程，如自动部署、测试等。
• GitHub Pages：用于托管静态网站，可以在网站上展示 Gitartwork 生成的贡献图。
• 持续集成/持续部署 (CI/CD) 工具：例如 Jenkins、Travis CI 等，可以与 Gitartwork 结合，实现自动化构建和部署。

通过这些典型的生态项目，Gitartwork 能够更好地融入开源项目的整个生命周期，并为开发者提供更有价值的信息。

gitartwork Gitartwork on user's contribution graph 项目地址: https://gitcode.com/gh_mirrors/gi/gitartwork