https://github.com/padupe/script-validate-bs-integration
Script that validates if the organization's repositories have the integration file with Backstage.
https://github.com/padupe/script-validate-bs-integration
backstage backstage-catalog javascript octokit script
Last synced: 11 months ago
JSON representation
Script that validates if the organization's repositories have the integration file with Backstage.
- Host: GitHub
- URL: https://github.com/padupe/script-validate-bs-integration
- Owner: padupe
- License: mit
- Created: 2023-06-30T15:43:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-30T18:42:24.000Z (almost 3 years ago)
- Last Synced: 2025-03-31T09:14:50.967Z (about 1 year ago)
- Topics: backstage, backstage-catalog, javascript, octokit, script
- Language: JavaScript
- Homepage:
- Size: 106 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
script-validate-bs-integration
## Index
- [Description](#description)
- [Flow](#flow)
- [Requirements](#requirements)
- [General](#general)
- [Secrets](#secrets)
- [How to use?](#how-to-use)
- [Contribute](#contribute)
---
## Description
Script that validates if the organization's repositories have the integration file with [Backstage](https://backstage.io/).
---
## Requirements
### General
- [Node.js](https://nodejs.org/en/) v16 || v18;
- [Yarn](https://yarnpkg.com/).
### Secrets
| What? | Data Type | Description |
| :--: | :--: | :-- |
| `GITHUB_TOKEN` | String | Token with read permissions to organization repositories for interaction via GitHub API. |
| `ORG_GITHUB` | String | Organization name on GitHub. |
| `BRANCH_DEFAULT_NAME` | String | Primary (or default) branch name. |
| `INTEGRATION_FILE` | String | Integration file name (usually `catalog-info.yaml`) |
---
## How to use?
1 - Clone the project.
>SSH
```bash
git clone git@github.com:padupe/script-validate-bs-integration.git
```
>HTTPS
```bash
git clone https://github.com/padupe/script-validate-bs-integration.git
```
2 - Access the project directory.
3 - Create the `.env` file according to the `example.env` template and enter the required values.
4 - Install the dependencies.
```bash
yarn install
```
5 - Run the command:
```bash
node src/index.js
```
---
## Contribute
Check our [CONTRIBUTING](./CONTRIBUTING.md) guidelines.