Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Add docker scripts and just shim #1964

Merged
merged 4 commits into from
Nov 14, 2022
Merged

Add docker scripts and just shim #1964

merged 4 commits into from
Nov 14, 2022

Conversation

AetherUnbound
Copy link
Contributor

Description

This PR adds two docker scripts, docker:build and docker:run, to the pnpm package.json config. I've also replaced the uses of those docker commands in the README with the associated pnpm command.

I've also added a justfile to this repo so just can be used in lieu of pnpm. Since we use just for our other projects, this can help make the workflow similar to our other projects!

Testing Instructions

Run the following:

  1. just
  2. just run docker:build
  3. just run docker:run

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated 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.

@AetherUnbound AetherUnbound requested a review from a team as a code owner November 9, 2022 19:01
@AetherUnbound AetherUnbound added ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed 🤖 aspect: dx Concerns developers' experience with the codebase labels Nov 9, 2022
@github-actions
Copy link

github-actions bot commented Nov 9, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1964
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1964/tailwind

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

README.md Outdated Show resolved Hide resolved
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

Love it.

Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

Nice!

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

The Docker-related scripts are a great addition. I'm not so sure about just but I appreciate the cross-repo consistency and I don't mind it because pnpm run continues to work.

@AetherUnbound
Copy link
Contributor Author

I'm not so sure about just but I appreciate the cross-repo consistency and I don't mind it because pnpm run continues to work.

I find my muscle memory is so strong that every time I come to work on something on the frontend I'm always so surprised I can't use any of my j shortcuts 😅 The consistency is great for me since I use pnpm so infrequently!

@AetherUnbound AetherUnbound merged commit 2f2b362 into main Nov 14, 2022
@AetherUnbound AetherUnbound deleted the feature/just branch November 14, 2022 19:21
github-actions bot pushed a commit that referenced this pull request Nov 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🤖 aspect: dx Concerns developers' experience with the codebase ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants