Skip to content

Commit cb4ee0e

Browse files
andrii-bodnarandrii-bodnar
authored
docs: default values (#257)
1 parent de0012c commit cb4ee0e

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

‎README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -110,62 +110,62 @@ By default, the action will look for the `crowdin.yml` file in the root of the r
110110

111111
| Option | Description | Example value |
112112
|----------------------------|----------------------------------------------------------------------------------------------------|------------------------------|
113-
| `upload_sources` | Specifies whether or not to upload sources to Crowdin | `true` |
114-
| `upload_translations` | Specifies whether or not to upload existing translations to Crowdin | `false` |
113+
| `upload_sources` | Specifies whether or not to upload sources to Crowdin | `true` (default) |
114+
| `upload_translations` | Specifies whether or not to upload existing translations to Crowdin | `false` (default) |
115115
| `upload_language` | Upload translations for a single specified language | `uk` |
116-
| `auto_approve_imported` | Automatically approve added translations | `true` |
117-
| `import_eq_suggestions` | Add translations even if they match the source strings | `true` |
116+
| `auto_approve_imported` | Automatically approve added translations | `false` (default) |
117+
| `import_eq_suggestions` | Add translations even if they match the source strings | `false` (default) |
118118
| `upload_sources_args` | Allows passing any supported arguments of the [`upload sources`][upload-sources] command | `--no-auto-update label=web` |
119119
| `upload_translations_args` | Allows passing any supported arguments of the [`upload translations`][upload-translations] command | `--translate-hidden` |
120120

121121
### Download options
122122

123123
| Option | Description | Example value |
124124
|------------------------------|--------------------------------------------------------------------------------------------------------|-------------------------------------|
125-
| `download_sources` | Specifies whether to download sources from Crowdin | `true` |
126-
| `download_translations` | Specifies whether to download translations from Crowdin | `true` |
125+
| `download_sources` | Specifies whether to download sources from Crowdin | `false` (default) |
126+
| `download_translations` | Specifies whether to download translations from Crowdin | `false` (default) |
127127
| `download_bundle` | The numeric ID of the Bundle you want to download translations from | `1` |
128128
| `download_language` | Download translations for a single specified language | `uk` |
129-
| `skip_untranslated_strings` | Skip untranslated strings when downloading translations | `true` |
130-
| `skip_untranslated_files` | Skip untranslated files when downloading translations | `true` |
131-
| `export_only_approved` | Include only approved translations in exported files | `true` |
129+
| `skip_untranslated_strings` | Skip untranslated strings when downloading translations | `false` (default) |
130+
| `skip_untranslated_files` | Skip untranslated files when downloading translations | `false` (default) |
131+
| `export_only_approved` | Include only approved translations in exported files | `false` (default) |
132132
| `download_sources_args` | Allows passing any supported arguments of the [`download sources`][download-sources] command | `--reviewed` |
133133
| `download_translations_args` | Allows passing any supported arguments of the [`download translations`][download-translations] command | `--all --skip-untranslated-strings` |
134134

135135
### Git and Pull Request options
136136

137-
| Option | Description | Example value |
138-
|---------------------------------|--------------------------------------------------------------------------------------------------------------|----------------------------------------------|
139-
| `push_translations` | Push downloaded translations to the branch | `true` |
140-
| `push_sources` | Push downloaded sources to the branch | `true` |
141-
| `localization_branch_name` | The name of the git branch that Crowdin will create when pushing translations or sources | `l10n_crowdin_action` |
142-
| `commit_message` | The commit message for the pushed changes | `New Crowdin translations by GitHub Action` |
143-
| `create_pull_request` | Specifies whether to create a pull request with the translations | `true` |
144-
| `pull_request_title` | The pull request title | `New Crowdin translations` |
145-
| `pull_request_body` | The pull request body | `New Crowdin pull request with translations` |
146-
| `pull_request_labels` | The pull request labels | `localization, l10n` |
147-
| `pull_request_assignees` | The pull request assignees | `crowdin-bot` |
148-
| `pull_request_reviewers` | The pull request reviewers | `user-reviewer` |
149-
| `pull_request_team_reviewers` | The pull request team reviewers | `team-reviewer` |
150-
| `pull_request_base_branch_name` | The git branch name to with pull request will be created. If not specified, the default branch is used | `main` |
151-
| `skip_ref_checkout` | Skip the default git checkout on `GITHUB_REF` if you need to checkout multiple branches in a single workflow | `false` |
137+
| Option | Description | Example value |
138+
|---------------------------------|--------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
139+
| `push_translations` | Push downloaded translations to the branch | `true` (default) |
140+
| `push_sources` | Push downloaded sources to the branch | `true` (default) |
141+
| `localization_branch_name` | The name of the git branch that Crowdin will create when pushing translations or sources | `l10n_crowdin_action` (default) |
142+
| `commit_message` | The commit message for the pushed changes | `New Crowdin translations by GitHub Action` (default) |
143+
| `create_pull_request` | Specifies whether to create a pull request with the translations | `true` (default) |
144+
| `pull_request_title` | The pull request title | `New Crowdin translations by GitHub Action` (default) |
145+
| `pull_request_body` | The pull request body | `New Crowdin pull request with translations` |
146+
| `pull_request_labels` | The pull request labels | `localization, l10n` |
147+
| `pull_request_assignees` | The pull request assignees | `crowdin-bot` |
148+
| `pull_request_reviewers` | The pull request reviewers | `user-reviewer` |
149+
| `pull_request_team_reviewers` | The pull request team reviewers | `team-reviewer` |
150+
| `pull_request_base_branch_name` | The git branch name to with pull request will be created. If not specified, the default branch is used | `main` |
151+
| `skip_ref_checkout` | Skip the default git checkout on `GITHUB_REF` if you need to checkout multiple branches in a single workflow | `false` (default) |
152152

153153
### Global options
154154

155155
| Option | Description | Example value |
156156
|------------------------|--------------------------------------------------------------------------------------------|----------------------------|
157157
| `crowdin_branch_name` | Option to upload or download files to the specified version branch in your Crowdin project | `l10n_branch` |
158158
| `config` | Option to specify a path to the configuration file (without `/` at the beginning) | `path/to/your/crowdin.yml` |
159-
| `dryrun_action` | Defines whether to run the action in the dry-run mode | `false` |
159+
| `dryrun_action` | Defines whether to run the action in the dry-run mode | `false` (default) |
160160

161161
### GitHub (Enterprise) configuration
162162

163163
| Option | Description | Example value |
164164
|-----------------------|----------------------------------------------------------------------------------------------------------------------------|-------------------------------------|
165-
| `github_base_url` | Option to configure the base URL of GitHub server, if using GitHub Enterprise | `github.com` |
165+
| `github_base_url` | Option to configure the base URL of GitHub server, if using GitHub Enterprise | `github.com` (default) |
166166
| `github_api_base_url` | Options to configure the base URL of GitHub server for API requests, if using GHE and different from `api.github_base_url` | `api.[github_base_url]` |
167-
| `github_user_name` | Option to configure GitHub user name on commits | `Crowdin Bot` |
168-
| `github_user_email` | Option to configure GitHub user email on commits | `[email protected]` |
167+
| `github_user_name` | Option to configure GitHub user name on commits | `Crowdin Bot` (default) |
168+
| `github_user_email` | Option to configure GitHub user email on commits | `[email protected]` (default) |
169169
| `gpg_private_key` | GPG private key in ASCII-armored format | `${{ secrets.GPG_PRIVATE_KEY }}` |
170170
| `gpg_passphrase` | The passphrase for the ASCII-armored key | `${{ secrets.GPG_PASSPHRASE }}` |
171171

0 commit comments

Comments
 (0)