diff --git a/README.md b/README.md
index 87c43d23..a6171a29 100644
--- a/README.md
+++ b/README.md
@@ -55,26 +55,26 @@ Once you added this trigger Github will show a "Run workflow" button at the work
## Configuration
-The following inputs are available:
-
-| Input (click on name for description) | Allowed values | Required | Default |
-| :--- | :---: | :---: | :---: |
-| `repos-file`
Path to a file containing the list of repositories to update in markdown format (- owner/repo) | File paths | 👎🏼 | `''` |
-| `github-repository`
Repository to update. The current repository will be used by default | {{owner}}/{{repo}} | 👎🏼 | `$GITHUB_REPOSITORY` |
-| `github-token`
Github Personal Access Token with permission to create branches on repo (or `${{ secrets.GITHUB_TOKEN }}`) | Valid [Github Token](https://github.com/settings/tokens) | 👍🏼 | `''` |
-| `author-email`
Author email address to use in commits | Email address | 👎🏼 | Github user's *Public email* |
-| `author-name`
Author name to use in commits | String | 👎🏼 | Github user's *Name* |
-| `scala-steward-version`
Scala Steward version to use | Valid [Scala Steward's version](https://github.com/scala-steward-org/scala-steward/releases) | 👎🏼 | `0.12.0` |
-| `ignore-opts-files`
Whether to ignore "opts" files (such as `.jvmopts` or `.sbtopts`) when found on repositories or not | true/false | 👎🏼 | `true` |
-| `sign-commits`
Whether to sign commits or not | true/false | 👎🏼 | `false` |
-| `cache-ttl`
TTL of cache for fetching dependency versions and metadata. Set it to `0s` to disable cache completely. | like 24hours, 5min, 10s, or 0s | 👎🏼 | `2hours` |
-| `github-api-url`
The URL of the Github API, only use this input if you are using Github Enterprise | https://git.yourcompany.com/api/v3 | 👎🏼 | `https://api.github.com` |
-| `scalafix-migrations`
Scalafix migrations to run when updating dependencies. Check [here](https://github.com/scala-steward-org/scala-steward/blob/master/docs/scalafix-migrations.md) for more information. | Path to HOCON file
or remote URL
with [migration](https://github.com/scala-steward-org/scala-steward/blob/master/docs/scalafix-migrations.md) | 👎🏼 | `''` |
-| `artifact-migrations`
Artifact migrations to find newer dependency updates. Check [here](https://github.com/scala-steward-org/scala-steward/blob/master/docs/artifact-migrations.md) for more information. | Path to HOCON file
with [migration](https://github.com/scala-steward-org/scala-steward/blob/master/docs/artifact-migrations.md) | 👎🏼 | `''` |
-| `github-app-id`
This input in combination with `github-app-key` allows you to use this action as a "backend" for your own Scala Steward GitHub App. | A valid GitHub App ID | 👎🏼 | `''` |
-| `github-app-key`
The private key for the GitHub App set with `github-app-id`. This value should be extracted from a secret. This input in combination with `github-app-id` allows you to use this action as a "backend" for your own Scala Steward GitHub App. | A private key | 👎🏼 | `''` |
-| `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. See ["Updating a custom branch"](#updating-a-custom-branch). | A list of branches to update | 👎🏼 | `''` |
-| `default-repo-conf`
The path to a [`.scala-steward.conf`](https://github.com/scala-steward-org/scala-steward/blob/master/docs/repo-specific-configuration.md) file with default values for all repos updated with this action. | Path to a
[`.scala-steward.conf`](https://github.com/scala-steward-org/scala-steward/blob/master/docs/repo-specific-configuration.md)
default file | 👎🏼 | `.github/.scala-steward.conf` |
+The following inputs are available (all of them are optional):
+
+| Input (click on name for description) | Allowed values | Default |
+| :--- | :---: | :---: |
+| `repos-file`
Path to a file containing the list of repositories to update in markdown format (- owner/repo) | File paths | `''` |
+| `github-repository`
Repository to update. The current repository will be used by default | {{owner}}/{{repo}} | `$GITHUB_REPOSITORY` |
+| `github-token`
Github Personal Access Token with permission to create branches on repo (or `${{ secrets.GITHUB_TOKEN }}`) | Valid [Github Token](https://github.com/settings/tokens) | `''` |
+| `author-email`
Author email address to use in commits | Email address | Github user's *Public email* |
+| `author-name`
Author name to use in commits | String | Github user's *Name* |
+| `scala-steward-version`
Scala Steward version to use | Valid [Scala Steward's version](https://github.com/scala-steward-org/scala-steward/releases) | `0.12.0` |
+| `ignore-opts-files`
Whether to ignore "opts" files (such as `.jvmopts` or `.sbtopts`) when found on repositories or not | true/false | `true` |
+| `sign-commits`
Whether to sign commits or not | true/false | `false` |
+| `cache-ttl`
TTL of cache for fetching dependency versions and metadata. Set it to `0s` to disable cache completely. | like 24hours, 5min, 10s, or 0s | `2hours` |
+| `github-api-url`
The URL of the Github API, only use this input if you are using Github Enterprise | https://git.yourcompany.com/api/v3 | `https://api.github.com` |
+| `scalafix-migrations`
Scalafix migrations to run when updating dependencies. Check [here](https://github.com/scala-steward-org/scala-steward/blob/master/docs/scalafix-migrations.md) for more information. | Path to HOCON file
or remote URL
with [migration](https://github.com/scala-steward-org/scala-steward/blob/master/docs/scalafix-migrations.md) | `''` |
+| `artifact-migrations`
Artifact migrations to find newer dependency updates. Check [here](https://github.com/scala-steward-org/scala-steward/blob/master/docs/artifact-migrations.md) for more information. | Path to HOCON file
with [migration](https://github.com/scala-steward-org/scala-steward/blob/master/docs/artifact-migrations.md) | `''` |
+| `github-app-id`
This input in combination with `github-app-key` allows you to use this action as a "backend" for your own Scala Steward GitHub App. | A valid GitHub App ID | `''` |
+| `github-app-key`
The private key for the GitHub App set with `github-app-id`. This value should be extracted from a secret. This input in combination with `github-app-id` allows you to use this action as a "backend" for your own Scala Steward GitHub App. | A private key | `''` |
+| `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. See ["Updating a custom branch"](#updating-a-custom-branch). | A list of branches to update | `''` |
+| `default-repo-conf`
The path to a [`.scala-steward.conf`](https://github.com/scala-steward-org/scala-steward/blob/master/docs/repo-specific-configuration.md) file with default values for all repos updated with this action. | Path to a
[`.scala-steward.conf`](https://github.com/scala-steward-org/scala-steward/blob/master/docs/repo-specific-configuration.md)
default file | `.github/.scala-steward.conf` |
### Specify JVM version
@@ -92,14 +92,7 @@ There are several options for the Github Token:
#### Using the default Github Action Token
-Just provide it to the action using `github-token` input:
-
-```yaml
-- name: Launch Scala Steward
- uses: scala-steward-org/scala-steward-action@v2
- with:
- github-token: ${{ github.token }}
-```
+By default, the action will use the default GitHub Token if none is provided via `github-token`.
> Beware that if you use the default github-token [no workflows will run](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow) on Scala Steward PRs.
diff --git a/action.yml b/action.yml
index 8ba576d8..0e65ed28 100644
--- a/action.yml
+++ b/action.yml
@@ -14,7 +14,8 @@ inputs:
required: false
github-token:
description: "Github Personal Access Token with permission to create branches on repo"
- required: true
+ required: false
+ default: ${{ github.token }}
author-email:
description: Author email address to use in commits
required: false
@@ -30,7 +31,8 @@ inputs:
default: "true"
required: false
branches:
- description: A comma-separated list of branches to update (if not provided, the repository's default branch will be
+ description:
+ 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.
required: false
sign-commits: