https://github.com/tharindadilshan/ballerina-dependabot-action

A GitHub action to provide a functionality similar to GitHub Dependabot for Ballerina projects.
https://github.com/tharindadilshan/ballerina-dependabot-action

action ballerina ballerina-dependabot dependabot dependencies

Last synced: 29 days ago
JSON representation

A GitHub action to provide a functionality similar to GitHub Dependabot for Ballerina projects.

• Host: GitHub
• URL: https://github.com/tharindadilshan/ballerina-dependabot-action
• Owner: TharindaDilshan
• License: mit
• Created: 2020-12-04T05:50:19.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-01-11T03:56:00.000Z (almost 4 years ago)
• Last Synced: 2024-10-15T17:38:46.869Z (29 days ago)
• Topics: action, ballerina, ballerina-dependabot, dependabot, dependencies
• Language: Python
• Homepage:
• Size: 41 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ballerina-dependabot-action ![Test](https://github.com/TharindaDilshan/ballerina-dependabot-action/workflows/Test/badge.svg)

This GitHub action will provide a functionality similar to GitHub [Dependabot](https://github.com/dependabot/) for Ballerina projects. The action will check the [Ballerina Central](https://central.ballerina.io/), for latest versions of the modules found in the Ballerina.toml file and raise Pull Requests for each module with version updates.

# Usage

See this [repo](https://github.com/TharindaDilshan/ballerina-dependabot-extended) for a real world example.

## Inputs

| Input        | Required | Description                 |

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

| git_email    | Yes      | GitHub email address        |

| git_username | Yes      | GitHub username             |

| token        | Yes      | GitHub Access Token         |

| file_path    | No       | Path to Ballerina.toml file |

**Note** - File path is required if the Ballerina.toml file does not resides in the repository root.

If Ballerina.toml resides in the `ballerina_project` directory, `file_path: ballerina_project/`. The trailing `/` is required if the file_path is specified explicitly.

## Example

```

- uses: TharindaDilshan/ballerina-dependabot-action@main

  with:

     git_email: ${{ secrets.GITHUB_EMAIL }}

     git_username: ${{ secrets.GITHUB_USERNAME}}

     token: ${{ secrets.GITHUB_TOKEN }}

```

## Full Example

The action is scheduled to run every Sunday at 12:00 a.m.(IST) to check for dependency updates.

```

name: Ballerina Dependabot

on: 

  schedule:

        - cron: '30 18 * * 7'

jobs:

  resolve_dependencies:

    runs-on: ubuntu-latest

    name: Dependabot

    steps:

      - name: Checkout

        uses: actions/checkout@v2

      - name: Dependabot Action

        uses: TharindaDilshan/ballerina-dependabot-action@main

        with:

          git_email: ${{ secrets.GITHUB_EMAIL }}

          git_username: ${{ secrets.GITHUB_USERNAME}}

          token: ${{ secrets.GITHUB_TOKEN }}

          file_path: project_1/

```

## References

[Creating encrypted secrets for a repository](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)

[GitHub workflow - scheduled events](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#scheduled-events)