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

Show detect screen during detect phase #1230

Merged
merged 2 commits into from
Sep 1, 2021

Conversation

aemengo
Copy link
Contributor

@aemengo aemengo commented Jul 12, 2021

Summary

Visually depict pack build: detect phase

This PR kicks off the pack-interact epic and proposes the following user workflow:

When a user runs a pack build like so: pack build <image-name> --interactive
Then the user will view the build process through a terminal UI screen

Currently only the Detecting... page will show

Documentation

  • Should this change be documented?
    • Yes, see #___
    • No
    • Not yet

Related

Resolves: #1201

@github-actions github-actions bot added this to the 0.20.0 milestone Jul 12, 2021
@github-actions github-actions bot added type/chore Issue that requests non-user facing changes. type/enhancement Issue that requests a new feature or improvement. labels Jul 12, 2021
@aemengo aemengo changed the title wip: Show detect screen during detect phase Show detect screen during detect phase Jul 12, 2021
@jromero jromero modified the milestones: 0.20.0, 0.21.0 Jul 14, 2021
@aemengo aemengo force-pushed the pack-interact-mode branch from a938e62 to 55f34f3 Compare July 26, 2021 04:51
@github-actions github-actions bot modified the milestones: 0.21.0, 0.20.0 Jul 26, 2021
@aemengo aemengo force-pushed the pack-interact-mode branch 6 times, most recently from ce21746 to 75aaf38 Compare July 30, 2021 05:09
@aemengo aemengo force-pushed the pack-interact-mode branch 2 times, most recently from 1493986 to 81d6203 Compare August 9, 2021 04:58
@codecov
Copy link

codecov bot commented Aug 9, 2021

Codecov Report

Merging #1230 (e761c5b) into main (efffe58) will increase coverage by 0.10%.
The diff coverage is 85.00%.

❗ Current head e761c5b differs from pull request most recent head ccc4a9d. Consider uploading reports for the commit ccc4a9d to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1230      +/-   ##
==========================================
+ Coverage   81.19%   81.29%   +0.10%     
==========================================
  Files         140      142       +2     
  Lines        8596     8710     +114     
==========================================
+ Hits         6979     7080     +101     
- Misses       1180     1193      +13     
  Partials      437      437              
Flag Coverage Δ
os_linux 79.90% <77.86%> (+0.07%) ⬆️
os_macos 77.23% <72.86%> (+0.16%) ⬆️
os_windows 81.19% <85.00%> (+0.10%) ⬆️
unit 81.29% <85.00%> (+0.10%) ⬆️

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

@aemengo aemengo force-pushed the pack-interact-mode branch from 81d6203 to 53b54a3 Compare August 9, 2021 13:52
@aemengo aemengo marked this pull request as ready for review August 9, 2021 14:25
@aemengo aemengo requested a review from a team as a code owner August 9, 2021 14:25
@jromero jromero modified the milestones: 0.20.0, 0.21.0 Aug 9, 2021
@aemengo aemengo marked this pull request as draft August 12, 2021 14:24
@aemengo aemengo force-pushed the pack-interact-mode branch from 53b54a3 to e761c5b Compare August 13, 2021 04:48
@aemengo aemengo marked this pull request as ready for review August 13, 2021 05:00
@jromero
Copy link
Member

jromero commented Aug 18, 2021

@aemengo, what's the state of this PR? I've tried running it and the UI looks nice but I can see a few things having issues.

  1. The screen doesn't seem to clear certain sections properly ending up with a "BUILDINGNG". (See screenshot)
  2. The workflow tends to halt at "EXPORTING" and never proceeds until I CTRL+C.

Also, I notice that there are a few TODOs in the code.

Is this ready for review or maybe it should be in a draft state? How much focus do we need to put on it at the moment?

@aemengo
Copy link
Contributor Author

aemengo commented Aug 18, 2021

@jromero

What's the state of this PR?

My hope is that it is "ready for review". I'm currently soliciting feedback.

The screen doesn't seem to clear certain sections properly ending up with a "BUILDINGNG". (See screenshot)

Thanks for bringing it up. Unfortunately, I did not (and still do don't) see this behavior. May I ask how you're running the build?

The workflow tends to halt at "EXPORTING" and never proceeds until I CTRL+C.

Again, I'm not really sure what you're seeing. You simply need to run pack build <image-name> --interactive. The only words that should be visible is "Detecting...".
Happy to look at this with you.

There are a few TODOs in the code. How much focus do we need to put on it at the moment?

The TODOs were reminders to create subsequent issues, not to be handled this one. I can remove the TODOs, if needed. There are a few more PRs to make before the user workflow is completed. The aim of this is PR is to make sure that the abstractions are correct now, while the costs of changing them is lower. If this PR is merged (or deemed acceptable), I can immediately work on the follow-up issues that will complete mockup laid out in the RFC.

@jromero
Copy link
Member

jromero commented Aug 18, 2021

@jromero

What's the state of this PR?

My hope is that it is "ready for review". I'm currently soliciting feedback.

The screen doesn't seem to clear certain sections properly ending up with a "BUILDINGNG". (See screenshot)

Thanks for bringing it up. Unfortunately, I did not (and still do don't) see this behavior. May I ask how you're running the build?

Here's a recording of what I see: https://asciinema.org/a/friKslqt0jNVVRrogauRJw2qy

pack-dev is...

❯ which pack-dev
/usr/local/bin/pack-dev

❯ ls -al /usr/local/bin/pack-dev
lrwxr-xr-x  1 jromero  admin  43 Nov 19  2020 /usr/local/bin/pack-dev -> /Users/jromero/dev/buildpacks/pack/out/pack

This is on fish but there is no difference on bash. Also, using iTerm 2. Also, tried different window sizes - no change. Anything else that might help troubleshoot this?

The workflow tends to halt at "EXPORTING" and never proceeds until I CTRL+C.

Again, I'm not really sure what you're seeing. You simply need to run pack build <image-name> --interactive. The only words that should be visible is "Detecting...".
Happy to look at this with you.

HMU if you want to pair on it.

There are a few TODOs in the code. How much focus do we need to put on it at the moment?

The TODOs were reminders to create subsequent issues, not to be handled this one. I can remove the TODOs, if needed. There are a few more PRs to make before the user workflow is completed. The aim of this is PR is to make sure that the abstractions are correct now, while the costs of changing them is lower. If this PR is merged (or deemed acceptable), I can immediately work on the follow-up issues that will complete mockup laid out in the RFC.

I would prefer that a) they be removed or b) they link to an issue. Your choice. 😄

@aemengo aemengo force-pushed the pack-interact-mode branch from ccc4a9d to c59923c Compare August 18, 2021 23:30
@aemengo
Copy link
Contributor Author

aemengo commented Aug 18, 2021

TODOs linked in latest commit. Will contact you about pre-existing UI errors tomorrow.

Signed-off-by: Anthony Emengo <aemengo@vmware.com>
@aemengo aemengo force-pushed the pack-interact-mode branch from c59923c to 5ae344a Compare August 25, 2021 21:33
Signed-off-by: Anthony Emengo <aemengo@vmware.com>
@aemengo aemengo force-pushed the pack-interact-mode branch from 5ae344a to 8dd4ab5 Compare August 25, 2021 21:43
@jromero jromero merged commit b3f9390 into buildpacks:main Sep 1, 2021
@jromero jromero added experimental Issue or PR refers to an experimental feature. and removed type/chore Issue that requests non-user facing changes. labels Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
experimental Issue or PR refers to an experimental feature. type/enhancement Issue that requests a new feature or improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pack build should visually depict detect step
2 participants