open-index/open-npm huggingface dataset:
npm package: @roadiehq/backstage-entity-validator-test-ci
Description: Backstage entity validator
Author: RoadieHQ
Latest version: 0.3.9-test

# Backstage entity validator

This package can be used as a GitHub action or a standalone node.js module

## GitHub action

### Inputs

#### `path`

**Optional** Path to the catalog-info.yaml file to validate. Defaults to `catalog-info.yaml` at the root of the repository. It also can be a glob like `services/*/catalog-info.yaml` or a list of files seperated by comma `users.yaml,orgs/company.yaml`.

#### `verbose`

**Optional** Specify whether the output should be verbose. Default `true`.

### Outputs

None. Prints out the validated YAML on success. Prints out errors on invalid YAML

### Example usage
```
- uses:  RoadieHQ/backstage-entity-validator@v0.3.2
  with:
    path: 'catalog-info-1.yaml'
```

```
- uses:  RoadieHQ/backstage-entity-validator@v0.3.2
  with:
    path: 'catalog-info-1.yaml,catalog-info-2.yaml,catalog-info-3.yaml'
```

```
- uses:  RoadieHQ/backstage-entity-validator@v0.3.2
  with:
    path: 'catalog-info-*.yaml,services/**/*/catalog-info.yaml'
```

## CircleCI Orb

### Inputs

#### `path`

**Optional** Path to the catalog-info.yaml file to validate. Defaults to `catalog-info.yaml` at the root of the repository.

### Outputs

None. Prints out the validated YAML on success. Prints out errors on invalid YAML

### Example config
```
description: >
  Sample catalog-info.yaml validation
usage:
  version: 2.1
  orbs:
    entity-validator: "roadiehq/backstage-entity-validator@0.3.0"
  workflows:
    use-entity-validator:
      jobs:
        - entity-validator/validate:
            path: catalog-info.yaml
```


## Using the CLI

### Usage

```
Usage: validate-entity [OPTION] [FILE]

Validates Backstage entity definition files.  Files may be specified as
arguments or via STDIN, one per line.

OPTION:
-h  display help
-q  minimal output while validating entities
-i  validate files provided over standard input
```

Examples:

```
# in a shell

# validate all entities contained in the "catalog" and subfolders
validate-entity catalog/**/*.yaml

# list of files produced by a script to validate
find-relevant-yaml-files.sh | validate-entity -i 
```

### Installing and running

#### As a global tool

```
# install
npm install --global @roadiehq/backstage-entity-validator

# run
validate-entity file1.yaml file2.yaml
```
#### In an existing node project

```
# install
npm install --save-dev @roadiehq/backstage-entity-validator

# run
npx validate-entity file1.yaml file2.yaml
```

#### When working on this tool

```
# install
npm install

# run
npm run validate file1.yaml file2.yaml

# or
bin/bev file1.yaml file2.yaml
```
npm package: @roadiehq/backstage-plugin-catalog-import
Description: Welcome to the catalog-import plugin!
Latest version: 0.1.0

# catalog-import

Welcome to the catalog-import plugin!

_This plugin was created through the Backstage CLI_

## Getting started

Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/github-insights](http://localhost:3000/github-insights).

You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.
npm package: @roadiehq/backstage-plugin-code-insights
Description: ![a preview of the code insights plugin](https://raw.githubusercontent.com/RoadieHQ/backstage-plugin-code-insights/main/docs/code-insights-plugin.png)
Latest version: 0.1.0
Deprecated: this package has superseded by @roadiehq/backstage-plugin-github-insights

# Code Inights Plugin for Backstage

![a preview of the code insights plugin](https://raw.githubusercontent.com/RoadieHQ/backstage-plugin-code-insights/main/docs/code-insights-plugin.png)

## Plugin Setup

1. If you have standalone app (you didn't clone this repo), then do

```bash
yarn add @roadiehq/backstage-plugin-code-insights
```

2. Add plugin to the list of plugins:

```ts
// packages/app/src/plugins.ts
export { plugin as CodeInsights } from '@roadiehq/backstage-plugin-code-insights';
```

3. Add plugin API to your Backstage instance:

```ts
// packages/app/src/components/catalog/EntityPage.tsx
import { Router as CodeInsightsRouter } from '@roadiehq/backstage-plugin-code-insights';

...

const ServiceEntityPage = ({ entity }: { entity: Entity }) => (
  <EntityPageLayout>
    ...
    <EntityPageLayout.Content
      path="/code-insights"
      title="Code Insights"
      element={<CodeInsightsRouter entity={entity} />}
    />
  </EntityPageLayout>
```

4. Run backstage app with `yarn start` and navigate to services tabs.

## Widgets setup

1. You must install plugin by following the steps above to add widgets to your Overview. You might add only selected widgets or all of them.

2. Add widgets to your Overview tab:

```ts
// packages/app/src/components/catalog/EntityPage.tsx
import { ContributorsCard, LanguagesCard, ReadMeCard, ReleasesCard } from '@roadiehq/backstage-plugin-code-insights';

...

const OverviewContent = ({ entity }: { entity: Entity }) => (
  <Grid container spacing={3}>
    ...
    <Grid item md={6}>
      <ContributorsCard entity={entity} />
      <LanguagesCard entity={entity} />
      <ReleasesCard entity={entity} />
    </Grid>
    <Grid item md={6}>
      <ReadMeCard entity={entity} />
    </Grid>
  </Grid>
);

```

## Features

- Add Code Insights plugin tab.
- Show widgets about repository contributors, languages, readme and release at overview page.

## Links

- [Backstage](https://backstage.io)
- Get hosted, managed Backstage for your company: https://roadie.io
npm package: @roadiehq/backstage-plugin-vouch-redirect-fetch
Description: It aims to enable the usage of web api resources secured by [vouch-proxy](https://github.com/vouch/vouch-proxy).
Latest version: 0.1.0

# Vouch redirect Plugin for Backstage

It aims to enable the usage of web api resources secured by [vouch-proxy](https://github.com/vouch/vouch-proxy). 

This plugin exports a function `fetchWithVouchRedirect` and a component `AuthPopup`.

`AuthPopup` component has to be set as a page in the root backstage reducer like this:

```tsx
import { AuthPopup } from '@roadiehq/backstage-plugin-vouch-redirect';
...
<Routes>
  ...
  <Route path="/authpopup" element={<AuthPopup />} />
</Routes>
```

`fetchWithVouchRedirect` has to be called with two parameters:

- url of the desired resource as a first parameter
- url to the vouch-proxy server login endpoint as a second parameter

```tsx
import { fetchWithVouchRedirect } from '@roadiehq/backstage-plugin-vouch-redirect';
...
    fetchWithVouchRedirect(
      'https://api.myorganization.com/api/catalog/entities',
      'https://vouch.myorganization.com/login',
    );
```

`fetchWithVouchRedirect` function will attempt to fetch the resource and if the vouch session cookie is not set, it will open a popup with the login form (from provider configured in the vouch-proxy server) and after user succesfully logs in, popup will close and the resources will be fetched again.


Following settings are required in vouch-proxy configuration:

- `sameSite` parameter for vouch cookie has to be set to `none`
- backstage origin has to be added to the allowed redirect domains

```yml
  vouch:
    cookie:
      sameSite: none
    domains: ["backstageorigin", ...domains]
```
npm package: @roadiehq/techdocs-cli
Description: Utility CLI for managing TechDocs sites in Roadie.
Latest version: 2.0.0

# roadie-techdocs-cli

[![NPM Version badge](https://img.shields.io/npm/v/@techdocs/cli)](https://www.npmjs.com/package/@roadiehq/techdocs-cli)

## Usage

See [roadie-techdocs-cli usage docs](https://roadie.io/docs/getting-started/technical-documentation/).