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

Structures Dockerfile based on operation, and simplifies dev environment #3295

Merged
merged 3 commits into from
Nov 6, 2023

Conversation

pavish
Copy link
Member

@pavish pavish commented Nov 6, 2023

Fixes #2973

Technical details

  • Dockerfile:
    • Adds structure to our Dockerfile, based on operation performed. Previously:
      • It wasn't clear where to add a new dependency that I wanted installed
    • Removes dockerize.It isn't needed after the changes to the compose file (see next parah)
    • Installs gettext, which is required for i18n project
  • docker-compose.dev.yml

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@pavish pavish added the pr-status: review A PR awaiting review label Nov 6, 2023
@pavish pavish requested a review from mathemancer November 6, 2023 12:59
@pavish
Copy link
Member Author

pavish commented Nov 6, 2023

@mathemancer I'm just noticing that changes to the Dockerfile, and compose script, do not run our tests. I think we should change this behaviour to run tests.

Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall, but see my specific comment on the Dockerfile.

Dockerfile Outdated
Comment on lines 23 to 26
RUN apt-get update -y;

# Install common dependencies
RUN apt-get install -y --no-install-recommends sudo ca-certificates curl gnupg gettext nodejs locales;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's important to use apt-get update in the same RUN command as apt-get install whenever the latter is used.

See: https://docs.docker.com/develop/develop-images/instructions/#apt-get

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I've added f8011db to resolve this.

@mathemancer mathemancer added the pr-status: revision A PR awaiting follow-up work from its author after review label Nov 6, 2023
@mathemancer mathemancer assigned pavish and unassigned mathemancer Nov 6, 2023
@mathemancer mathemancer removed the pr-status: review A PR awaiting review label Nov 6, 2023
@pavish pavish assigned mathemancer and unassigned pavish Nov 6, 2023
@pavish pavish added pr-status: review A PR awaiting review and removed pr-status: revision A PR awaiting follow-up work from its author after review labels Nov 6, 2023
@pavish pavish requested a review from mathemancer November 6, 2023 16:32
Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, this looks good to me.

@mathemancer mathemancer added this pull request to the merge queue Nov 6, 2023
Merged via the queue into develop with commit 5fb2019 Nov 6, 2023
21 checks passed
@mathemancer mathemancer deleted the simplify-dockerfile-and-dev-env branch November 6, 2023 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Starting the dev service starts the db container which is nonessential
2 participants