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

Docs: Add verdi process status command to tutorial #4508

Merged
merged 2 commits into from
Oct 26, 2020

Conversation

mbercx
Copy link
Member

@mbercx mbercx commented Oct 24, 2020

Fixes #4505

Currently the verdi process status command is only mentioned once in the documentation (in topics/processes/usage ). Since this command is both useful for getting a nice succinct overview of a work chain and debugging, it deserves a mention in the basic tutorial.

This PR adds the command just before generating the final provenance graph.

Copy link
Contributor

@sphuber sphuber left a comment

Choose a reason for hiding this comment

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

Thanks @mbercx . Have two comments

docs/source/intro/tutorial.rst Outdated Show resolved Hide resolved
docs/source/intro/tutorial.rst Outdated Show resolved Hide resolved
@mbercx mbercx force-pushed the fix/4505/docs_process_status branch from e886ed1 to 5102be4 Compare October 25, 2020 22:59
@mbercx mbercx requested a review from sphuber October 25, 2020 23:01
ltalirz
ltalirz previously approved these changes Oct 25, 2020
Copy link
Member

@ltalirz ltalirz left a comment

Choose a reason for hiding this comment

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

thanks @mbercx - looks good to me.

don't know whether you want to wait for more input before merging

docs/source/intro/tutorial.rst Outdated Show resolved Hide resolved
ltalirz
ltalirz previously approved these changes Oct 25, 2020
@mbercx
Copy link
Member Author

mbercx commented Oct 25, 2020

Thanks @ltalirz! Will still give @sphuber a chance to comment before merging.

csadorf
csadorf previously approved these changes Oct 26, 2020
Copy link
Contributor

@csadorf csadorf left a comment

Choose a reason for hiding this comment

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

LGTM.

Copy link
Contributor

@sphuber sphuber left a comment

Choose a reason for hiding this comment

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

All good for me. I was just wondering if we should add that it is recursive, meaning that if one of the called processes itself also calls subprocesses, those will also be shown recursively. This might not be obvious since the example only has a single level

@mbercx
Copy link
Member Author

mbercx commented Oct 26, 2020

All good for me. I was just wondering if we should add that it is recursive, meaning that if one of the called processes itself also calls subprocesses, those will also be shown recursively. This might not be obvious since the example only has a single level

I think it's ok to leave it as it is. As you said, the example doesn't demonstrate the recursion, and I think it will be clear if they use this command on a work chain where one of the processes also calls subprocesses.

@sphuber sphuber self-requested a review October 26, 2020 10:05
sphuber
sphuber previously approved these changes Oct 26, 2020
Copy link
Contributor

@sphuber sphuber left a comment

Choose a reason for hiding this comment

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

Good to go

mbercx and others added 2 commits October 26, 2020 11:20
@mbercx mbercx dismissed stale reviews from sphuber, csadorf, and ltalirz via a4b71a2 October 26, 2020 10:21
@mbercx mbercx force-pushed the fix/4505/docs_process_status branch from 5f3469f to a4b71a2 Compare October 26, 2020 10:21
@mbercx mbercx requested a review from ltalirz October 26, 2020 10:26
@mbercx
Copy link
Member Author

mbercx commented Oct 26, 2020

Had to rebase to develop, which dismissed the reviews. I always do this by rebasing on my work station and force-pushing to my repo branch. Is that the recommended approach?

@sphuber
Copy link
Contributor

sphuber commented Oct 26, 2020

Had to rebase to develop, which dismissed the reviews. I always do this by rebasing on my work station and force-pushing to my repo branch. Is that the recommended approach?

If the commits of the PR will be squashed anyway, then this is not necessary. You can simply use the "Update branch" button of Github to merge develop into the branch. That will not dismiss the reviews, and so is the preferred option. For PRs that contain multiple commits that have to be kept, and so either merge-commit or rebase-merge strategy will be used, in that case one has to rebase locally and force push. The PR will have to be reaccepted in this case, but that is actually a good thing, since it will have to check the rebase was done correctly

@mbercx
Copy link
Member Author

mbercx commented Oct 26, 2020

Right, we weren't running all the checks for the documentation PR's. How do I get GitHub to run all the checks so I can merge the PR?

@sphuber sphuber merged commit ee13ad6 into aiidateam:develop Oct 26, 2020
@sphuber
Copy link
Contributor

sphuber commented Oct 26, 2020

We cannot, because the checks re explicitly skipped, so we can only merge with admin rights, bypassing the checks. This is not ideal. If you could look, maybe with @chrisjsewell , how the skipping can be done within the action, such that it still runs, but it just shortcuts if the unit tests don't actually have to run. This would be the better solution, because then the PRs will also not show up as "still running" with the yellow circle but will get the green checkmark

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: use verdi process status in tutorial
4 participants