Skip to content

Commit

Permalink
feat: branch comparison
Browse files Browse the repository at this point in the history
  • Loading branch information
@brenoepics
brenoepics committed Sep 29, 2024
1 parent f66e9ec commit e0d5c56
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 16 deletions.
29 changes: 15 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ request alerts and display badges effortlessly.
<summary>Preview</summary>

![image](https://github.com/user-attachments/assets/aea8dbb9-49c8-4206-abba-9e4d475040ad)
![img.png](preview.png)

</details>

Expand Down Expand Up @@ -60,7 +61,7 @@ jobs:
node-version: '20'

- name: Vue Mess Detector Analysis
uses: brenoepics/vmd-action@v0.0.3
uses: brenoepics/vmd-action@v0.0.4
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
# check inputs for full args list
Expand All @@ -77,19 +78,19 @@ artifacts.
> [!TIP]
> You can find the list of inputs and their descriptions in the [action.yml](action.yml) file.
| Input | Description | Required | Default |
|-------------------|--------------------------------------------------|----------|---------------------------------------------------------|
| github-token | GitHub token for commenting on pull requests | `false` | |
| version | Version of Vue Mess Detector | `true` | [`latest`](https://github.com/rrd108/vue-mess-detector) |
| skipInstall | Skip the installation of Vue Mess Detector | `true` | `false` |
| skipBots | Skip running analysis on pull requests from bots | `true` | `true` |
| commentsEnabled | Comment on Pull requests? | `true` | `true` |
| packageManager | Package manager to use | `false` | (detect) |
| runArgs | Arguments to pass to Vue Mess Detector | `false` | `--group=file` |
| entryPoint | Entry point for Vue Mess Detector | `false` | `./` |
| srcDir | Source directory to analyze | `true` | `src/` |
| deleteOldComments | Delete old VMD comments on pull requests? | `false` | `false` |
| compareWithBranch | Branch to compare the analysis results with | `false` | `main` |
| Input | Description | Required | Default |
|-------------------|------------------------------------------------------|----------|---------------------------------------------------------|
| github-token | GitHub token for commenting on pull requests | `false` | |
| version | Version of Vue Mess Detector | `true` | [`latest`](https://github.com/rrd108/vue-mess-detector) |
| skipInstall | Skip the installation of Vue Mess Detector | `true` | `false` |
| skipBots | Skip running analysis on pull requests from bots | `true` | `true` |
| commentsEnabled | Comment on Pull requests? | `true` | `true` |
| packageManager | Package manager to use | `false` | (detect) |
| runArgs | Arguments to pass to Vue Mess Detector | `false` | `--group=file` |
| entryPoint | Entry point for Vue Mess Detector | `false` | `./` |
| srcDir | Source directory to analyze | `true` | `src/` |
| deleteOldComments | Delete old report comments on pull requests? | `false` | `false` |
| relativeMode | Compare the current branch with the target (PR only) | `true` | `true` |

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ inputs:
required: false
default: "false"
relativeMode:
description: "Generate relative analysis based on the base branch"
description: "Generate a report comparing the current branch with the target branch"
required: true
default: "true"
runs:
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vmd-action",
"version": "0.0.3",
"version": "0.0.4",
"description": "",
"main": "dist/index.js",
"type": "module",
Expand Down
Binary file added preview.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e0d5c56

Please sign in to comment.