GitHub Action
Repo-List-Generator
The GitHub action that generate repository list for user.
The personal access token (PAT) used to fetch the repository. Guide in here.
- ⚡️ Repo List Generator GitHub Action
- 🎨 Table of Contents
- 🚀 Configuration
- 📝 Example
- 📝 Use dependabot to keep action up-to-date
- 🙈 Generate
my_token
- 🔊 CHANGELOG
- 📄 LICENSE
inputs:
user:
description: 'Set up the user to generate repository list.'
required: false
default: ${{ github.actor }}
maxPage:
description: 'Set up maxPage for request to generate repository list.(default 100 repository per page.)'
required: false
default: 10
my_token:
description: 'Set up the personal access token (PAT) to generate repository list for user.'
required: true
outputs:
repoList:
description: >
Repository list exclude private and fork
Source without private(Public) and no fork
repoList_ALL:
description: >
Repository list include private and fork
Source and fork
repoList_PRIVATE:
description: >
Repository list include private
Source and no fork
repoList_FORK:
description: >
Repository list include fork
Source without private(Public) and fork
privateList:
description: >
Private repository list
Only private(fork can not be private)
forkList:
description: >
Fork repository list
Only fork(private can not be fork)
This example use REPO_TOKEN
to fetch repository list. The Guide to generate in here.
- name: Get Repo List
id: repo
uses: yi-Xu-0100/repo-list-generator@v0.0.2
with:
my_token: ${{ secrets.REPO_TOKEN }}
- name: Echo Output
run: |
echo repoList:${{steps.repo.outputs.repoList}}
echo repoList_ALL:${{steps.repo.outputs.repoList_ALL}}
echo repoList_PRIVATE:${{steps.repo.outputs.repoList_PRIVATE}}
echo repoList_FORK:${{steps.repo.outputs.repoList_FORK}}
echo privateList:${{steps.repo.outputs.privateList}}
echo forkList:${{steps.repo.outputs.forkList}}
More Related Usage: This action result can be used in static_list
generating. The follow are Examples.
- yi-Xu-0100/hub-mirror use Yikun/hub-mirror-action to synchronize
GitHub
repositories toGitee
. - yi-Xu-0100/traffic-to-badge use repositories
Insights/traffic
data to generate badges that include views and clones.
This file is build in ./github/dependabot.yml
to keep action up-to-date.
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: 'daily'
This part is obtained from yi-Xu-0100/traffic-to-badge.
You'll first need to create a personal access token (PAT) which make the action having the access to the GitHub API.
You can generate a PAT by going to Settings(GitHub) -> Developer Settings -> Personal Access Tokens -> Generate new token
, and will need to grant repo permission. For more information, see the GitHub documentation.
After you generated the PAT, go to Settings(repository) -> Secrets -> New secret
, name the secret REPO_TOKEN
and copy the PAT into the box.