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

feat: Enable playground in Docker build #1986

Merged
merged 4 commits into from
Oct 20, 2023

Conversation

nasdf
Copy link
Member

@nasdf nasdf commented Oct 19, 2023

Relevant issue(s)

Resolves #1983

Description

This PR enables the embedded playground in the DefraDB Docker builds.

Tasks

  • I made sure the code is well commented, particularly hard-to-understand areas.
  • I made sure the repository-held documentation is changed accordingly.
  • I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in tools/configs/chglog/config.yml).
  • I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ...

How has this been tested?

Built and pushed image to docker.io/sourcenetwork/defradb:develop

Specify the platform(s) on which this was tested:

  • MacOS

@nasdf nasdf added the platforms Related to platform deployment label Oct 19, 2023
@nasdf nasdf added this to the DefraDB v0.8 milestone Oct 19, 2023
@nasdf nasdf self-assigned this Oct 19, 2023
@nasdf nasdf requested a review from a team October 19, 2023 19:55
@codecov
Copy link

codecov bot commented Oct 19, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e0e1779) 74.19% compared to head (57d0daa) 74.20%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #1986      +/-   ##
===========================================
+ Coverage    74.19%   74.20%   +0.01%     
===========================================
  Files          246      246              
  Lines        24426    24426              
===========================================
+ Hits         18121    18124       +3     
+ Misses        5093     5091       -2     
+ Partials      1212     1211       -1     
Flag Coverage Δ
all-tests 74.20% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e0e1779...57d0daa. Read the comment docs.

Copy link
Contributor

@AndrewSisley AndrewSisley left a comment

Choose a reason for hiding this comment

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

LGTM - are there any downsides to including this?

Copy link
Member

@shahzadlone shahzadlone left a comment

Choose a reason for hiding this comment

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

LGTM.

question: Out of scope of this PR, but often times when I see the playground dependencies being bumped (non-go deps) I wonder if the tests or some aspect in the build would catch if a dependency broke the playground stuff. Is there a way to (if we don't already) run these tests in ci to ensure playground state isn't broken. Does this PR in anyway improve that situation?

@nasdf
Copy link
Member Author

nasdf commented Oct 20, 2023

LGTM - are there any downsides to including this?

Just an increase in size and an extra Docker build step.

@nasdf
Copy link
Member Author

nasdf commented Oct 20, 2023

LGTM.

question: Out of scope of this PR, but often times when I see the playground dependencies being bumped (non-go deps) I wonder if the tests or some aspect in the build would catch if a dependency broke the playground stuff. Is there a way to (if we don't already) run these tests in ci to ensure playground state isn't broken. Does this PR in anyway improve that situation?

It should let us know if the playground build is failing in the Docker build workflow. It would be nice to automate a test that runs the Docker container and loads the playground.

@nasdf nasdf merged commit 55e8628 into sourcenetwork:develop Oct 20, 2023
29 checks passed
shahzadlone pushed a commit to shahzadlone/defradb that referenced this pull request Feb 23, 2024
## Relevant issue(s)

Resolves sourcenetwork#1983

## Description

This PR enables the embedded playground in the DefraDB Docker builds.

## Tasks

- [x] I made sure the code is well commented, particularly
hard-to-understand areas.
- [x] I made sure the repository-held documentation is changed
accordingly.
- [x] I made sure the pull request title adheres to the conventional
commit style (the subset used in the project can be found in
[tools/configs/chglog/config.yml](tools/configs/chglog/config.yml)).
- [x] I made sure to discuss its limitations such as threats to
validity, vulnerability to mistake and misuse, robustness to
invalidation of assumptions, resource requirements, ...

## How has this been tested?

Built and pushed image to `docker.io/sourcenetwork/defradb:develop`

Specify the platform(s) on which this was tested:
- MacOS
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
platforms Related to platform deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable playground in Docker image
3 participants