Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yi-xu-0100/repo-list-generator
📃 The GitHub action that generate repository list for user or organization.
https://github.com/yi-xu-0100/repo-list-generator
action generator github javascript list repo repo-list
Last synced: 2 months ago
JSON representation
📃 The GitHub action that generate repository list for user or organization.
- Host: GitHub
- URL: https://github.com/yi-xu-0100/repo-list-generator
- Owner: yi-Xu-0100
- License: mit
- Created: 2020-10-11T09:16:38.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-04T14:41:48.000Z (over 1 year ago)
- Last Synced: 2024-09-22T08:02:00.995Z (4 months ago)
- Topics: action, generator, github, javascript, list, repo, repo-list
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/repo-list-generator
- Size: 1.71 MB
- Stars: 10
- Watchers: 3
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚡️ Repo List Generator GitHub Action
[![sync2gitee(list)]()](https://github.com/yi-Xu-0100/hub-mirror)
[](https://github.com/yi-Xu-0100/repo-list-generator/actions?query=workflow%3Atest)
[](https://github.com/yi-Xu-0100/repo-list-generator)
[](https://github.com/yi-Xu-0100/repo-list-generator/releases)
[](./LICENSE)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-repo-list-generator)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-repo-list-generator)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-repo-list-generator)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-repo-list-generator)
The GitHub action that generate repo list for user or organization.
**The personal access token (PAT) is used to fetch all the repository list of the authenticated user. Guide in [here](#-generate-my_token).**
## 🎨 Table of Contents
- [🎨 Table of Contents](#-table-of-contents)
- [🚀 Configuration](#-configuration)
- [📝 Default example](#-default-example)
- [📝 Example for get private repository](#-example-for-get-private-repository)
- [🚀 More Related Usage](#-more-related-usage)
- [📝 Use dependabot to keep action up-to-date](#-use-dependabot-to-keep-action-up-to-date)
- [🙈 Generate `my_token`](#-generate-my_token)
- [🔊 CHANGELOG](#-changelog)
- [📄 LICENSE](#-license)
## 🚀 Configuration
```yml
inputs:
user:
description: >
Set up the user name to generate repository list.
It can be user or organization.
The 'owner/repository' will transform to 'owner'.
required: false
default: ${{ github.repository }}
max_page:
description: >
Set up maxPage for request to generate repository list.
Default 100 repository per page can be fetched.
required: false
default: 10
my_token:
description: >
Set up the personal access token (PAT).
The PAT is used to generate repository list for user or organization.
required: false
default: ${{ github.token }}
block_list:
description: >
Set up the block_list for repoList.
The repositories in block_list will exclude in repository list.
required: false
default: ''
allow_empty:
description: >
Set up whether allow empty repository for repoList.
required: false
default: false
allow_archived:
description: >
Set up whether allow archived repository for repoList.
required: false
default: true
outputs:
repo:
description: >
Current repository name.
repoList:
description: >
Repository list exclude private and fork.
Public(source without private) and no fork.
repoList_ALL:
description: >
Repository list include private and fork.
Source(public and private) and fork
repoList_PRIVATE:
description: >
Repository list include private.
Source(public and private) and no fork.
repoList_FORK:
description: >
Repository list include fork.
Public(source without private) 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).
emptyList:
description: >
Empty repository list.
Default exclude in each list.
archivedList:
description: >
Archived repository list.
Default include in each list.
```
## 📝 Default example
**Default example use `GITHUB_TOKEN` to fetch public repository list for user or organization.**
```yml
- name: Get Repo List
id: repo
uses: yi-Xu-0100/[email protected]
# with:
# (default)my_token: ${{ secrets.GITHUB_TOKEN }}
# (default)user: ${{ github.repository }}
# (default)max_page: 10
# (default)block_list:
# (default)allow_empty: false
# (default)allow_archived: true
- name: Echo Output
run: |
echo repo: ${{steps.repo.outputs.repo}}
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}}
echo emptyList: ${{steps.repo.outputs.emptyList}}
echo archivedList: ${{steps.repo.outputs.emptyList}}
```
## 📝 Example for get private repository
**This example use `REPO_TOKEN` to fetch private repository list for user or organization. The Guide to generate in [here](#-generate-my_token).**
```yml
- name: Get Repo List
id: repo
uses: yi-Xu-0100/[email protected]
with:
my_token: ${{ secrets.REPO_TOKEN }}
# (default)user: ${{ github.repository }}
# (default)max_page: 10
# (default)block_list:
# (default)allow_empty: false
# (default)allow_archived: true
- name: Echo Output
run: |
echo repo: ${{steps.repo.outputs.repo}}
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}}
echo emptyList: ${{steps.repo.outputs.emptyList}}
echo archivedList: ${{steps.repo.outputs.emptyList}}
```
## 🚀 More Related Usage
**This action result can be used in the follow actions `static_list` generating.**
- [yi-Xu-0100/hub-mirror](https://github.com/yi-Xu-0100/hub-mirror) use [Yikun/hub-mirror-action](https://github.com/Yikun/hub-mirror-action) to synchronize `GitHub` repositories to `Gitee`.
- [yi-Xu-0100/traffic-to-badge](https://github.com/yi-Xu-0100/traffic-to-badge) use repositories `Insights/traffic` data to generate badges that include views and clones.
## 📝 Use dependabot to keep action up-to-date
This file is build in [`./github/dependabot.yml`](./.github/dependabot.yml) to keep action up-to-date.
```yaml
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: 'daily'
```
## 🙈 Generate `my_token`
> This part is obtained from [yi-Xu-0100/traffic-to-badge](https://github.com/yi-Xu-0100/traffic-to-badge#-generate-my_token).
You'll first need to create a personal access token (PAT) which make the action having the access to the GitHub API of the authenticated user.
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](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
After you generated the PAT, go to `Settings(repository) -> Secrets -> New secret`, name the secret `REPO_TOKEN`, and copy the PAT into the box. Then, you can use the `${{ secrets.REPO_TOKEN }}` to fill with the input `my_token`.
## 🔊 CHANGELOG
- [CHANGELOG](./CHANGELOG.md)
## 📄 LICENSE
- [MIT](./LICENSE)