https://github.com/halleck45/action-ast-metrics

Github action for AST Metrics
https://github.com/halleck45/action-ast-metrics

Last synced: 25 days ago
JSON representation

Github action for AST Metrics

• Host: GitHub
• URL: https://github.com/halleck45/action-ast-metrics
• Owner: Halleck45
• License: mit
• Created: 2024-03-14T20:39:55.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-03T18:32:20.000Z (8 months ago)
• Last Synced: 2024-10-15T17:58:10.761Z (2 months ago)
• Size: 110 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# ast-action

> Github action for [AST Metrics](https://github.com/Halleck45/ast-metrics/)

This will automatically add a markdown report to your build, containing metrics about your project (e.g. maintainability, complexity, etc.)

An artifact will also be created, containing the detailed HTML report.

## Example

On each build, you will get something like this:

![Example](./docs/preview.png)

You will find [live example here](https://github.com/Halleck45/DesignPatternDetector/actions/runs/8293499298) (if the build is still available).

## Usage

Create a `.github/workflows/ast-metrics.yml` file with the following content:

```yaml

name: AST Metrics

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

        - name: AST Metrics

          uses: halleck45/[email protected]

```

## Inputs

+ `version`: The version of AST Metrics to use. Default: `latest`

```yaml

- uses: halleck45/[email protected]

  with:

    version: 'v0.0.0-alpha'

```

+ `directory`: The directory to analyze. Default: `.`

```yaml

- uses: halleck45/[email protected]

  with:

    directory: 'src'

```

## License

MIT. See [LICENSE](LICENSE) for more details.