scala-steward-org/Scala Steward GitHub Action
🤖 A bot that helps you keeping your Scala projects up-to-date
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| artifact-migrations | Artifact migrations for newer versions of artifacts with different group Ids, artifact ids, or both different. Expects the path to HOCON file with migration/s. See https://github.com/scala-steward-org/scala-steward/blob/main/docs/artifact-migrations.md | no | — |
| author-email | Author email address to use in commits. If set it will override any email retrieved from GitHub. | no | — |
| author-name | Author name to use in commits. If set it will override any name retrieved from GitHub. | no | — |
| branches | A comma-separated list of branches to update (if not provided, the repository's default branch will be updated instead). This option only has effect if updating the current repository or using the `github-repository` input. | no | — |
| cache-ttl | TTL of cache for fetching dependency versions and metadata, set it to 0s to disable it. | no | 2hours |
| max-buffer-size | Size of the buffer for the output of an external process in lines. The default is 16384. | no | 16384 |
| coursier-cli-url | Url to download the coursier linux CLI from. | no | https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-linux.gz |
| mill-repository | Maven repository to download Mill distribution artifacts from when the requested Mill version ships from Maven (Mill 0.12.x and newer). Set this to a Maven mirror URL (without a trailing slash) if your runner is rate-limited by Maven Central. | no | https://repo1.maven.org/maven2 |
| do-not-fork | Whether to not push the update branches to a fork. | no | true |
| extra-jars | Extra JARs to be added to the classpath of the launched application. Directories accepted too. | no | — |
| github-api-url | The URL of the GitHub API, only use this input if you are using GitHub Enterprise. | no | ${{ github.api_url }} |
| github-app-auth-only | If set to `true` the GitHub App information will only be used for authentication. Repositories to update will be read from either the `repos-file` or the `github-repository` inputs. | no | false |
| github-app-id | GitHub App ID. See the "Installation" section of the README to learn how to set up the app and how to fill this input. | no | — |
| github-app-installation-id | GitHub App Installation ID. See the "Installation" section of the README to learn how to set up the app and how to fill this input. | no | — |
| github-app-key | GitHub App Private Key. See the "Installation" section of the README to learn how to set up the app and how to fill this input. | no | — |
| github-repository | Repository to update. Will be ignored if either `repos-file` is provided or the `github-app-*` inputs are and `github-app-auth-only` is not `true`. | no | ${{ github.repository }} |
| github-token | GitHub Personal Access Token with permission to create branches on repo. If `github-app-*` inputs are provided an App's installation token will be used instead of this one. | no | ${{ github.token }} |
| ignore-opts-files | Whether to ignore "opts" files (such as `.jvmopts` or `.sbtopts`) when found on repositories or not. | no | true |
| mill-version | Mill version to install. Take into account this will just affect the global `mill` executable. Scala Steward will still respect the version specified in your repository while updating it. | no | 1.0.6 |
| other-args | Other Scala Steward arguments not yet supported by this action as a separate argument. | no | — |
| repo-config | Location of a `.scala-steward.conf` file with default values. If you specify a file and it does not exist in the selected branch then this action will fail when it runs. See https://github.com/scala-steward-org/scala-steward/blob/main/docs/repo-specific-configuration.md | no | .github/.scala-steward.conf |
| repos-file | Path to a file containing the list of repositories to update in markdown format: - owner/repo1 - owner/repo2 This input will be ignored if the `github-app-*` inputs are provided and `github-app-auth-only` is not `true`. | no | — |
| scala-steward-version | Scala Steward version to use. If not provided it will use the last one published. | no | — |
| scalafmt-version | Scalafmt version to install. If not provided, Coursier will install the version selected by its app descriptor. | no | — |
| scalafix-migrations | Scalafix rules for version updates to run after certain updates. Expects the path to HOCON file with migration/s. See https://github.com/scala-steward-org/scala-steward/blob/main/docs/scalafix-migrations.md | no | — |
| scalafix-dependency | Coursier dependency coordinates of the `scalafix-cli` artifact used to bootstrap the Scalafix executable. Override this if you need a Scalafix version with different runtime requirements (for example a JDK version) than the default. | no | ch.epfl.scala:scalafix-cli_2.13.18:0.14.7 |
| scala-cli-version | scala-cli version to install. If not provided, Coursier will install the version selected by its app descriptor. | no | — |
| sbt-version | sbt version to install. If not provided, Coursier will install the version selected by its app descriptor. | no | — |
| sign-commits | Whether to sign commits or not. | no | false |
| signing-key | Key ID of GPG key to use for signing commits. See the "Signing commits with GPG" section to learn how to prepare the environment and fill this input. | no | "" |
| timeout | Timeout for external process invocations. | no | 20min |
Outputs
no outputs