> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# sawadashota/orb-update

Update CircleCI Orbs versions
https://github.com/sawadashota/orb-update


## Commands

### default-config

Generate default configuration if not exists

| Parameter | Type | Default | Description |
|---|---|---|---|
| `config` | string | .orb-update.yml | Path of configuration for orb-update This option is for self testing. So please put config file at `.orb-update.yml`
 |

### orb-update

Execute orb-update command via docker command. Update each Orb version and create Pull Request on GitHub. This command must be executed in docker. Because CircleCI's read only SSH key in turn overrides GITHUB_TOKEN when `git push`


| Parameter | Type | Default | Description |
|---|---|---|---|
| `config` | string | .orb-update.yml | Path of configuration for orb-update
This option is for self testing. So please put config file at `.orb-update.yml`
 |
| `docker_image_version` | string | 0.3.3 | Version of docker image sawadashota/orb-update
https://hub.docker.com/r/sawadashota/orb-update
 |
| `github_token` | env_var_name | GITHUB_TOKEN | GitHub Token to read/create Pull Request
https://github.com/settings/tokens/new?scopes=repo,user:email&description=CircleCI%20for%20orb-update
 |
| `github_username` | env_var_name | GITHUB_USERNAME | Username of GitHub Token's owner |

## Jobs

### orb-update

Execute orb-update command. Update each Orb version and create Pull Request on GitHub.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `config` | string | .orb-update.yml | Path of configuration for orb-update
This option is for self testing. So please put config file at `.orb-update.yml`
 |
| `docker_image_version` | string | 0.3.3 | Version of docker image sawadashota/orb-update
https://hub.docker.com/r/sawadashota/orb-update
 |
| `github_token` | env_var_name | GITHUB_TOKEN | GitHub Token to read/create Pull Request
https://github.com/settings/tokens/new?scopes=repo,user:email&description=CircleCI%20for%20orb-update
 |
| `github_username` | env_var_name | GITHUB_USERNAME | Username of GitHub Token's owner |

## Examples

### update-every-night

Check and update orb every night.


```yaml
orbs:
  orb-update: sawadashota/orb-update@0.3.3
version: 2.1
workflows:
  orb-update:
    jobs:
      - orb-update/orb-update:
          github_token: GITHUB_TOKEN
          github_username: GITHUB_USERNAME
    triggers:
      - schedule:
          cron: 0 19 * * *
          filters:
            branches:
              only:
                - master
```