{"id":21820691,"url":"https://github.com/sue445/circleci-ruby-orbs","last_synced_at":"2025-04-14T03:01:26.701Z","repository":{"id":54642728,"uuid":"156033724","full_name":"sue445/circleci-ruby-orbs","owner":"sue445","description":" CircleCI orb for ruby","archived":false,"fork":false,"pushed_at":"2021-02-06T15:00:51.000Z","size":127,"stargazers_count":17,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-27T16:56:07.603Z","etag":null,"topics":["bundler","circleci-orb","circleci-orbs","ruby"],"latest_commit_sha":null,"homepage":"https://circleci.com/orbs/registry/orb/sue445/ruby-orbs","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sue445.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-03T23:49:55.000Z","updated_at":"2023-03-11T08:56:59.000Z","dependencies_parsed_at":"2022-08-13T22:31:24.175Z","dependency_job_id":null,"html_url":"https://github.com/sue445/circleci-ruby-orbs","commit_stats":null,"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sue445%2Fcircleci-ruby-orbs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sue445%2Fcircleci-ruby-orbs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sue445%2Fcircleci-ruby-orbs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sue445%2Fcircleci-ruby-orbs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sue445","download_url":"https://codeload.github.com/sue445/circleci-ruby-orbs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248813789,"owners_count":21165633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bundler","circleci-orb","circleci-orbs","ruby"],"created_at":"2024-11-27T16:38:29.785Z","updated_at":"2025-04-14T03:01:26.654Z","avatar_url":"https://github.com/sue445.png","language":"Ruby","readme":"# circleci-ruby-orbs\nCircleCI orb for ruby\n\nhttps://circleci.com/orbs/registry/orb/sue445/ruby-orbs\n\n[![CircleCI Orb Version](https://img.shields.io/badge/endpoint.svg?url=https://badges.circleci.io/orb/sue445/ruby-orbs)](https://circleci.com/orbs/registry/orb/sue445/ruby-orbs) \n[![CircleCI](https://circleci.com/gh/sue445/circleci-ruby-orbs/tree/master.svg?style=svg)](https://circleci.com/gh/sue445/circleci-ruby-orbs/tree/master)\n\n\n## Requirements\n* Ruby and bundler\n  * recommend [circleci/ruby](https://hub.docker.com/r/circleci/ruby/)\n\n## Usage\n### Common setting\n```yml\n# .circleci/config.yml\nversion: 2.1\n\norbs:\n  # Use specific version\n  # see. https://github.com/sue445/circleci-ruby-orbs/releases\n  ruby-orbs: sue445/ruby-orbs@1.4.4\n\n  # or\n  # Use latest version\n  # ruby-orbs: sue445/ruby-orbs@volatile\n```\n\n### bundle-install\nRun `bundle install` using cache.\n\n#### for app repo (`Gemfile.lock` is committed)\n```yml\n# .circleci/config.yml\njobs:\n  rspec:\n    docker:\n      - image: circleci/ruby\n\n    steps:\n      - checkout\n\n      - ruby-orbs/bundle-install\n      # or\n      - ruby-orbs/bundle-install:\n          cache_key_prefix: \"v1-bundle\"\n          bundle_jobs: 4\n          bundle_retry: 3\n          bundle_path: \"vendor/bundle\"\n          bundle_gemfile: \"Gemfile\"\n          bundle_clean: true\n          bundle_extra_args: \"\"\n          restore_bundled_with: true\n\n      # Add your job (e.g. rspec, rubocop)\n      - run: bundle exec rspec\n```\n\n#### for gem repo (`Gemfile.lock` is not committed)\n```yml\n# .circleci/config.yml\njobs:\n  rspec:\n    docker:\n      - image: circleci/ruby\n\n    steps:\n      - checkout\n\n      - ruby-orbs/bundle-install:\n          with_gemfile_lock: false\n          gemspec_name: \"yourgem\"\n      # or\n      - ruby-orbs/bundle-install:\n          with_gemfile_lock: false\n          gemspec_name: \"yourgem\"\n          cache_key_prefix: \"v1-bundle\"\n          bundle_jobs: 4\n          bundle_retry: 3\n          bundle_path: \"vendor/bundle\"\n          bundle_clean: true\n          bundle_extra_args: \"\"\n          update_always: false\n\n      # Add your job (e.g. rspec, rubocop)\n      - run: bundle exec rspec\n```\n\n#### Parameters\n* `cache_key_prefix` : Key prefix of cache (default: `v1-bundle`)\n* `bundle_jobs` : Passed to `bundle install --jobs` (default: `4`)\n* `bundle_retry` : Passed to `bundle install --retry` (default: `3`)\n* `bundle_path` : Passed to `bundle install --path` or use `bundle config set path` (default: `vendor/bundle`)\n* `bundle_gemfile` : Passed to `bundle install --gemfile` (default: `Gemfile`)\n* `bundle_clean` : Whether pass `--clean` to `bundle install` or use `bundle config set --local clean 'true'` (default: `true`)\n* `bundle_deployment` : Whether path to `--deployment` or run `bundle config set deployment 'true'` (default: `false`)\n* `bundle_frozen` : Whether path to `--frozen` or  run `bundle config set frozen 'true'` (default: `false`)\n* `bundle_no_cache` : Whether path to `--no-cache` or  run `bundle config set no-cache 'true'` (default: `false`)\n* `bundle_no_prune` : Whether path to `--no-prune` or  run `bundle config set no-prune 'true'` (default: `false`)\n* `bundle_shebang` : Whether path to `--shebang` or  run `bundle config set shebang 'true'` (default: `false`)\n* `bundle_system` : Whether path to `--system` or  run `bundle config set system 'true'` (default: `false`)\n* `bundle_without` : Passed to `bundle install --without` or `bundle config set without`\n* `bundle_with` : Passed to `bundle install --with` or `bundle config set with`\n* `bundle_extra_args` : Arguments to pass to `bundle install`\n* `restore_bundled_with` : Whether resolve bundler version difference between `Gemfile.lock` and pre-installed in CI (default: `true`)\n* `with_gemfile_lock` : Whether using `Gemfile.lock` for cache key (default: `true`)\n* `gemspec_name` : gemspec name (required if `with_gemfile_lock` is false)\n* `update_always` : Whether run always `bundle update` when `with_gemfile_lock` is disabled (default: `false`)\n\n### bundle-update-pr\nRun `bundle update` and send PullRequest.\n\nUses https://github.com/masutaka/circleci-bundle-update-pr\n\n```yml\nworkflows:\n  version: 2\n  nightly:\n    triggers:\n      - schedule:\n          cron: \"00 10 * * 5\"\n          filters:\n            branches:\n              only: master\n    jobs:\n      - ruby-orbs/bundle-update-pr\n      # or\n      - ruby-orbs/bundle-update-pr:\n          image: \"circleci/ruby:2.5.3\"\n          pre-bundle-update-pr:\n            - run:\n                name: \"Set timezone to Asia/Tokyo\"\n                command: \"sudo cp /usr/share/zoneinfo/Asia/Tokyo /etc/localtime\"\n            - ruby-orbs/bundle-install\n          git_user_name: \"yourname\"\n          git_user_email: \"you@example.com\"\n          github_access_token: GITHUB_ACCESS_TOKEN\n```\n\n#### Parameters\n* `image` : Image for `bundle update` (default: `circleci/ruby`)\n* `pre-bundle-update-pr` : Run steps before `circleci-bundle-update-pr` (default: `[]`)\n* `post-bundle-update-pr` : Run steps after `circleci-bundle-update-pr` (default: `[]`)\n* `version` : circleci-bundle-update-pr vesion. default is latest\n* `assignees` : Assign the PR to them. (e.g. alice,bob,carol)\n* `reviewers` : Request PR review to them. (e.g. alice,bob,carol)\n* `labels` : Add labels to the PR (e.g. In Review, Update)\n* `duplicate` : Make PR even if it has already existed (default: `false`)\n* `git_user_name` : Username for commit (default: `$GIT_USER_NAME`)\n* `git_user_email` : E-mail for commit (default: `$GIT_USER_EMAIL`)\n* `branch` : Space separated branches. (e.g. `master develop topic`) (default: `$CIRCLE_BRANCH`)\n* `github_access_token` : Your GitHub personal access token as an env var on CircleCI (default: `GITHUB_ACCESS_TOKEN`)\n  * Go to [your account's settings page](https://github.com/settings/tokens/new?description=circleci-bundle-update-pr%20token) and generate a personal access token with \"repo\" scope\n  * Use the CircleCI UI to set the GITHUB_ACCESS_TOKEN environment variable.\n* `enterprise_octokit_access_token` : Your GitHub Enterprise personal access token as an env var on CircleCI (default. `ENTERPRISE_OCTOKIT_ACCESS_TOKEN`)\n  * Use the CircleCI UI to set the ENTERPRISE_OCTOKIT_ACCESS_TOKEN environment variable.\n* `enterprise_octokit_api_endpoint` : Your GitHub Enterprise api endpoint (e.g. https://www.example.com/api/v3) (default: `$ENTERPRISE_OCTOKIT_API_ENDPOINT`)\n* `no_output_timeout` : Elapsed time the command can run without output. (e.g. 20m, 1.25h, 5s) (default: `10m`)\n\n## External\n* Smoke test repository for circleci-ruby-orbs\n  * https://github.com/sue445/circleci-ruby-orbs-test\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsue445%2Fcircleci-ruby-orbs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsue445%2Fcircleci-ruby-orbs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsue445%2Fcircleci-ruby-orbs/lists"}