https://github.com/lolgab/scalafmt

Github Action to run Scalafmt
https://github.com/lolgab/scalafmt

actions github scala scalafmt

Last synced: 24 days ago
JSON representation

Github Action to run Scalafmt

• Host: GitHub
• URL: https://github.com/lolgab/scalafmt
• Owner: lolgab
• License: apache-2.0
• Created: 2023-05-30T17:51:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-28T12:36:41.000Z (4 months ago)
• Last Synced: 2024-06-28T12:42:23.246Z (4 months ago)
• Topics: actions, github, scala, scalafmt
• Homepage:
• Size: 13.7 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Scalafmt Action

A GitHub Action to run Scalafmt on your Pull Requests and push the results back to your branch.

### Example

```yaml

name: scalafmt

on:

  - pull_request

jobs:

  scalafmt:

    runs-on: ubuntu-22.04

    steps:

      - uses: lolgab/[email protected]

        with:

          repo-token: ${{ secrets.GITHUB_TOKEN }}

```

### Configuration

#### `commit-message`

The commit message to use for the scalafmt changes

default: `style: Run Scalafmt`

#### `files`

Files to run Scalafmt on. Accepts newline separated list of globs

default:

```

**.scala

**.sbt

**.sc

```

#### `user-name`

Git username used to commit the change

default: `github-actions[bot]`

#### `user-email`

Git email used to commit the change

default: `41898282+github-actions[bot]@users.noreply.github.com`

#### `repo-token`

GitHub token to push changes

default: `${{ github.token }}`

The suggested value is: `${{ secrets.GITHUB_TOKEN }}`