菠菜众长李瑞豪的博客
菠菜众长李瑞豪的博客

Generate a list of all hugo-fixit theme components.

来源：hugo-fixit/action-component-list

hugo-fixit hugo-fixit 收录于 GitHub 和 开源项目
  约 700 字 预计阅读 4 分钟 - 次阅读  
目录
注意
本文最后更新于 2026-05-06，文中内容可能已过时。

action-component-list | FixIt

GitHub Super-Linter CI Check dist/ CodeQL

This is a GitHub Action to generate a list of all hugo-fixit theme components.

How to use

You can reference different stable versions of this action. For more information, see Versioning in the GitHub Actions toolkit.

To include the action in a workflow in another repository, you can use the uses syntax with the @ symbol to reference a specific branch, tag, or commit hash.

  1. Star this repository 😉

  2. Go to your repository

  3. Add the following section to your README.md file, you can give whatever title you want. Just make sure that you use <!-- HUGO_FIXIT_COMPONENTS:START --><!-- HUGO_FIXIT_COMPONENTS:END --> in your readme. The workflow will replace this comment with the actual blog post list:

    1
2
3
4

    # Hugo FixIt Components

<!-- HUGO_FIXIT_COMPONENTS:START -->
<!-- HUGO_FIXIT_COMPONENTS:END -->

  4. Create a folder named .github and create a workflows folder inside it, if it doesn’t exist.

  5. Create a new file named fixit-component-list.yml with the following contents inside the workflows folder:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

    name: Generate hugo-fixit component list
on:
  schedule: # Run workflow automatically
    - cron: '0 0 * * *' # Runs every day at 00:00 UTC
  workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the GitHub Actions Workflow page directly
permissions:
  contents: write # To write the generated contents to the readme

jobs:
  generate-component-list:
    name:
      Update this repo's README with the list of hugo-fixit theme components
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6
      - name: Generate hugo-fixit component list
        id: test-action
        uses: hugo-fixit/action-component-list@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          comment_tag_name: HUGO_FIXIT_COMPONENTS
          template: '- [{$repo.name}]({$repo.html_url}): {$repo.description}'
      - name: Print Output
        id: output
        run: echo "${{ steps.test-action.outputs.repos }}"
      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v8
        with:
          title: Update hugo-fixit component list
          commit-message: 'docs(readme): update hugo-fixit component list'
          body: This PR updates the hugo-fixit component list in the README.
          base: main
          branch: update-component-list
          labels: documentation
          # reviewers: Lruihao

  6. Go to repository settings, Click on Actions > General. Update the “Workflow permissions” to “Read and write permissions”. Click on save.

  7. Wait for it to run automatically, or you can also trigger it manually to see the result instantly.

Inputs

NameDescriptionDefault
comment_tag_nameThe tag name to look for in the readme fileHUGO_FIXIT_COMPONENTS
readme_pathComma separated paths of the readme files you want to update./README.md
exclude_reposComma separated list of repos to exclude from the list
templateTemplate to use while creating the list of hugo-fixit theme components. It can contain {$repo.name} etc. as variables- [{$repo.name}]({$repo.html_url}): {$repo.description}

Outputs

NameDescription
reposThe list of hugo-fixit theme components repos that were updated.

Example

Insert the following code block in your Markdown file to display the list of hugo-fixit components.

1
2
3
4

The list of hugo-fixit components will be displayed here.

<!-- HUGO_FIXIT_COMPONENTS:START -->
<!-- HUGO_FIXIT_COMPONENTS:END -->

The list of hugo-fixit components will be displayed here.

Buy me a coffee~
hugo-fixit 支付宝支付宝
hugo-fixit 微信微信
收录于 合集・开源项目 49
更新于 2026-05-06 398de13
CC BY-NC-SA 4.0
github-actions
返回 | 主页
微信公众号
切换 选择 ESC 关闭
搜索引擎 algolia

发现新版本

当前站点有新版本可用。