https://github.com/raven-actions/get-repos
🗄️ Get organization or user repos based on the topics filter (with logic AND/OR) to use in the matrix job or another action.
https://github.com/raven-actions/get-repos
action actions composite-action github-action github-actions raven-actions
Last synced: about 2 months ago
JSON representation
🗄️ Get organization or user repos based on the topics filter (with logic AND/OR) to use in the matrix job or another action.
- Host: GitHub
- URL: https://github.com/raven-actions/get-repos
- Owner: raven-actions
- License: mit
- Created: 2023-05-08T21:47:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-14T19:47:07.000Z (over 1 year ago)
- Last Synced: 2025-03-29T21:17:50.178Z (2 months ago)
- Topics: action, actions, composite-action, github-action, github-actions, raven-actions
- Homepage: https://github.com/marketplace/actions/get-repositories
- Size: 31.3 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 🗄️ Get Repositories Action
[](https://github.com/marketplace/actions/get-repositories)
[](https://github.com/raven-actions/get-repos/releases/latest)
[](https://github.com/raven-actions/get-repos/actions/workflows/ci.yml?query=branch%3Amain+event%3Apush)
[](https://github.com/raven-actions/get-repos/blob/main/LICENSE)
This [GitHub Action](https://github.com/features/actions) provides a list of repositories associated with a provided organization or user, with the option to include specific topics related to the repositories.
The primary purpose is to repeat a task for all repositories in an organization using the [GitHub Actions matrix](https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs) feature. It's the default behavior with `json` array output.
> ⚠️ With a job matrix, creating a maximum of **256** jobs per workflow run is possible!
You can also use this action to get a **flat** output with your delimiter for different purposes than the matrix job. Read more in the [Flat output](#flat-output) section.
## 📃 Table of Contents
- [🤔 Usage](#-usage)
- [Quick Start](#quick-start)
- [Flat output](#flat-output)
- [📥 Inputs](#-inputs)
- [📤 Outputs](#-outputs)
- [Example JSON output](#example-json-output)
- [Example FLAT output](#example-flat-output)
- [👥 Contributing](#-contributing)
- [📄 License](#-license)
## 🤔 Usage
### Quick Start
Example GitHub Workflow, to get all repositories that contain **ANY** of listed topics (`OR` operator is by default). Follow [📥 Inputs](#-inputs) to adjust behavior to `AND`. Then the result will be: get all repos with **ALL** listed topics.
```yaml
name: Sync Repositories
on:
schedule:
- cron: "30 6 * * *"
jobs:
get-repos:
name: Get Repos
runs-on: ubuntu-latest
outputs:
repos: ${{ steps.get-repos.outputs.repos }}
steps:
- name: Get Repositories Action
id: get-repos
uses: raven-actions/get-repos@v1
with:
topics: "sync,docs,managed"
sync-repos:
name: Sync (${{ matrix.repo.name }})
if: ${{ needs.get-repos.outputs.repos != '[]' }} # make sure repos exist
runs-on: ubuntu-latest
needs:
- get-repos
strategy:
matrix:
repo: ${{ fromJson(needs.get-repos.outputs.repos) }}
fail-fast: false
steps:
- name: Checkout
uses: actions/checkout@v3
with:
repository: ${{ matrix.repo.full_name }}
# rest of your workflow steps...
```
### Flat output
```yaml
- name: Get Repositories Action (flat)
id: get-repos
uses: raven-actions/get-repos@v1
with:
topics: "raven-actions,composite-action"
operator: AND # logic operator for topics match, AND returns repos that have all of provided topics, OR is default
format: flat
delimiter: "," # default one is '\n'
- name: Repos
run: |
echo "Total count: ${COUNT}"
echo "Format: ${FORMAT}"
echo "Repos:"
echo "${REPOS}"
env:
REPOS: ${{ steps.get-repos.outputs.repos }}
COUNT: ${{ steps.get-repos.outputs.count }}
FORMAT: ${{ steps.get-repos.outputs.format }}
```
## 📥 Inputs
| Name | Required | Type | Default value | Description |
|:--------------:|:--------:|:--------:|:-------------------------:|-----------------------------------------------------------------------------------------------------|
| `owner` | false | `string` | `github.repository_owner` | The organization or user name |
| `topics` | false | `string` | _not set_ | Comma-separated list of repository topics |
| `operator` | false | `string` | `OR` | Logic operator to use when filtering repositories by topics, `OR` or `AND` |
| `matrix-use` | false | `bool` | `true` | Output to be used in matrix job? It just checks that the returned query has not exceeded 256 repos |
| `format` | false | `string` | `json` | Output format, `json` or `flat`, default to `json` |
| `delimiter` | false | `string` | `\n` | Delimiter to use when `format` is `flat`, default to `\n` |
| `github-token` | false | `string` | `github.token` | GitHub Token with `repo` scope. Be aware results are always limited to permissions of GitHub tokens |
## 📤 Outputs
| Name | Type | Description |
|:--------:|:---------------:|-------------------------------------------------------------------------------------------------|
| `repos` | `json / string` | Repositories (JSON array object if format is set to `json` / string if format is set to `flat`) |
| `count` | `int` | Number of found repositories |
| `format` | `string` | Output format |
### Example JSON output
Each of the keys you can use in your matrix job.
```json
[
{
"owner": "raven-actions",
"name": "debug",
"full_name": "raven-actions/debug",
"private": false,
"html_url": "https://github.com/raven-actions/debug",
"fork": false,
"archived": false,
"disabled": false,
"is_template": false,
"visibility": "public",
"default_branch": "main"
},
{
"owner": "raven-actions",
"name": "actionlint",
"full_name": "raven-actions/actionlint",
"private": false,
"html_url": "https://github.com/raven-actions/actionlint",
"fork": false,
"archived": false,
"disabled": false,
"is_template": false,
"visibility": "public",
"default_branch": "main"
}
]
```
### Example FLAT output
The flat output with the custom delimiter `,`:
```text
raven-actions/debug,raven-actions/actionlint
```
> Flat output returns always full name! `owner/repo`
## 👥 Contributing
Contributions to the project are welcome! Please follow [Contributing Guide](https://github.com/raven-actions/get-repos/blob/main/.github/CONTRIBUTING.md).
## 📄 License
This project is distributed under the terms of the [MIT](https://github.com/raven-actions/get-repos/blob/main/LICENSE) license.