https://github.com/actions-cool/analyze-action

🔍 Help you analyze the action information.
https://github.com/actions-cool/analyze-action

actions analyze-action ts

Last synced: 16 days ago
JSON representation

🔍 Help you analyze the action information.

• Host: GitHub
• URL: https://github.com/actions-cool/analyze-action
• Owner: actions-cool
• License: mit
• Created: 2021-01-29T03:41:22.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-01-29T07:52:49.000Z (almost 4 years ago)
• Last Synced: 2024-10-15T17:16:58.573Z (about 1 month ago)
• Topics: actions, analyze-action, ts
• Language: TypeScript
• Homepage:
• Size: 8.79 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Analyze Action

After you request action.yml data through axios, it will help you analyze the obtained string and get the action information.

[![npm](https://img.shields.io/npm/v/analyze-action?style=flat-square&color=orange)](https://www.npmjs.com/package/analyze-action)

![](https://img.shields.io/github/workflow/status/actions-cool/analyze-action/CI?style=flat-square)

![](https://img.shields.io/npm/l/analyze-action?style=flat-square&color=blue)

## 🚀 Usage

```js

const { analyzeActionYml } = require('analyze-action');

// or

import { analyzeActionYml } from 'analyze-action';

analyzeActionYml(data);

```

## 🎁 API

- [analyzeActionYml](#analyzeactionyml) `1.0.0`

### analyzeActionYml

```js

analyzeActionYml(data, countOfficial);

```

#### Input

| Params | Desc | Type | Required | Default |

| -- | -- | -- | -- | -- |

| data | Oobtained string | string | ✔ | - |

| countOfficial | Whether to count the official action | boolean | ✖ | true |

#### Output

```js

{

  name: 'Issues Helper',

  actions: [

    owner: 'actions-cool',

    repo: 'issues-helper',

    version: 'v2.0.0'

  ]

}

```

## LICENSE

[MIT](https://github.com/actions-cool/analyze-action/blob/main/LICENSE)