Skip to content

Add Development Container #6

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

Closed
wants to merge 1 commit into from
Closed

Add Development Container #6

wants to merge 1 commit into from

Conversation

AJGranowski
Copy link
Contributor

@AJGranowski AJGranowski commented Jun 1, 2024

What are these changes?

Adds Docker/Podman support to this project.

Why are these changes being made?

A unified development environment improves the first-time developer experience, and makes the project more deterministic. Rather than needing a guide on installing prerequisite dependencies, developers can simply use the included container image and compose configuration to automatically generate a development environment. This also improves error reproduction and troubleshooting.

Simply run ./pnpm to launch a temporary container and execute PNPM on the project. Works with Podman and rootless Docker.

Checklist

  • ./pnpm install succeeds.
  • ./pnpm run ci succeeds.
  • ./pnpm run lint succeeds.
  • ./pnpm run dev succeeds.
  • ./pnpm run clean succeeds.
  • ./pnpm run build:js succeeds.
  • ./pnpm run build:types succeeds.
  • ./pnpm run build succeeds.
  • ./pnpm run prepare succeeds.
  • ./pnpm run prepublishOnly succeeds.

Additional notes:

  • git is not included in the image causing Husky to not install and return a 0 exit code.

@AJGranowski AJGranowski changed the title Add Development Containers Add Development Container Jun 2, 2024
@AJGranowski
Copy link
Contributor Author

Adding a patch to support rootful docker. Will open another PR when the update is ready.

@AJGranowski AJGranowski closed this Jun 2, 2024
@AJGranowski AJGranowski deleted the containers branch June 3, 2024 04:58
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.

1 participant