Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Binstubs For Running Server & Managing Docker Containers #16795

Merged
merged 29 commits into from
Jun 3, 2024

Conversation

stevenjcumming
Copy link
Contributor

@stevenjcumming stevenjcumming commented May 17, 2024

Summary

  • removed bin/deps and updated documentation mentioning it
  • Create a binstub for starting the rails server (locally)
    • Use foreman & Procfile to start the processes required for running the server
  • Create a binstub for managing docker containers such as building and rebuilding
  • Add documentation for "Running Binstubs"
  • Add Procfile.dev for local development
  • auto-skip sidekiq license if already set
  • skips postgres if running
    • exits with error if installed but not running

docs/setup/running_binstubs.md will provide the more detailed information if desired

Related issue(s)

Testing done

  • Manual tests of each binstub with each developer setup

Acceptance Criteria

  • bin/dev starts the rails server for native, hybrid, docker
  • bin/docker can build, clean, setup for ci, run db and bundle commands
  • each binstub has a help message
  • documentation is added for "Running Binstubs"

@stevenjcumming stevenjcumming requested review from a team as code owners May 17, 2024 18:55
@stevenjcumming stevenjcumming self-assigned this May 17, 2024
Copy link

github-actions bot commented May 17, 2024

1 Warning
⚠️ This PR changes 336 LoC (not counting whitespace/newlines).

In order to ensure each PR receives the proper attention it deserves, we recommend not exceeding
200. Expect some delays getting reviews.

File Summary

Files

  • .github/CODEOWNERS (+2/-0)

  • Procfile.dev (+4/-0)

  • bin/deps (+1/-1)

  • bin/dev (+60/-0)

  • bin/docker (+103/-0)

  • bin/lib/vets-api/README.md (+22/-3)

  • bin/lib/vets-api/commands/command.rb (+7/-3)

  • bin/lib/vets-api/commands/lint.rb (+1/-1)

  • bin/lib/vets-api/commands/setup.rb (+16/-5)

  • bin/lib/vets-api/commands/test.rb (+1/-1)

  • bin/lib/vets-api/setups/base.rb (+6/-6)

  • bin/lib/vets-api/setups/docker.rb (+3/-3)

  • bin/lib/vets-api/setups/hybrid.rb (+1/-1)

  • bin/lib/vets-api/setups/native.rb (+9/-1)

  • bin/setup (+8/-8)

  • bin/test (+1/-1)

  • docs/setup/binstubs.md (+2/-2)

  • docs/setup/running_binstubs.md (+53/-0)

    Note: We exclude files matching the following when considering PR size:

    *.csv, *.json, *.tsv, *.txt, Gemfile.lock, app/swagger, modules/mobile/docs, spec/fixtures/, spec/support/vcr_cassettes/, modules/mobile/spec/support/vcr_cassettes/, db/seeds, modules/vaos/app/docs, modules/meb_api/app/docs, modules/appeals_api/app/swagger/, *.bru
    

Big PRs are difficult to review, often become stale, and cause delays.

Generated by 🚫 Danger

@va-vsp-bot
Copy link
Collaborator

Error: A file (or its parent directories) was deleted but its reference still exists in CODEOWNERS. Please update the .github/CODEOWNERS file and delete the entry for the Offending file:

@va-vsp-bot
Copy link
Collaborator

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file:

@va-vfs-bot va-vfs-bot temporarily deployed to sjc-running-binstubs/main/main May 17, 2024 20:04 Inactive
@va-vsp-bot
Copy link
Collaborator

Error: A file (or its parent directories) was deleted but its reference still exists in CODEOWNERS. Please update the .github/CODEOWNERS file and delete the entry for the Offending file:

@va-vsp-bot
Copy link
Collaborator

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file:

@va-vfs-bot va-vfs-bot temporarily deployed to sjc-running-binstubs/main/main May 17, 2024 21:18 Inactive
Base automatically changed from sjc-master-binstubs to master May 29, 2024 14:18
@va-vfs-bot va-vfs-bot temporarily deployed to sjc-running-binstubs/main/main May 29, 2024 14:22 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to sjc-running-binstubs/main/main May 29, 2024 19:45 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to sjc-running-binstubs/main/main May 30, 2024 19:34 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to sjc-running-binstubs/main/main May 30, 2024 20:55 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to sjc-running-binstubs/main/main May 30, 2024 21:22 Inactive
@va-vsp-bot
Copy link
Collaborator

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file: Procfile.dev

@va-vfs-bot va-vfs-bot temporarily deployed to sjc-running-binstubs/main/main May 30, 2024 21:46 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to sjc-running-binstubs/main/main May 30, 2024 22:12 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to sjc-running-binstubs/main/main May 30, 2024 22:20 Inactive
@stevenjcumming stevenjcumming merged commit d23d602 into master Jun 3, 2024
19 checks passed
@stevenjcumming stevenjcumming deleted the sjc-running-binstubs branch June 3, 2024 12:26
cloudmagic80 pushed a commit that referenced this pull request Jun 3, 2024
* add binstubs for setup, test, lint, and deps

* minor updates in documentation and fixing testing issue

* update CODEOWNERS

* fix clamav initializer

* updates based on PR comments

* update bin/dep

* grab required ruby version from .ruby_version

* rubocop formatting

* refactor commands

* refactor setups

* readability update for docker setup and refactor CODEOWNERS

* rubocop formatting

* remove comment

* private method refactoring

* exit if postgis install fails

* add bin/dev and bin/docker for running & maintainer docker

* add documentation for running binstubs

* update CODEOWNERS

* fix broken setup binstub & add docker readme

* fix spelling

* add bin/docker to list

* rubocop formatting

* update based on comments

* add Procfile.dev

* update CODEOWNERS

* allow docker to start separately from procfile & update docker-compose to docker compose

* rubocop formatting
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants