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

UX: Report branch names and states in WTF report #5804

Merged
merged 2 commits into from Jul 26, 2021
Merged

Conversation

adswa
Copy link
Member

@adswa adswa commented Jul 21, 2021

This potentially closes #5731. It adds a section "branches" to the dataset report of datalad wtf, and reports all branches using the format <branch>[@<commit>].
For example:

(handbook2) adina@muninn in ~/repos/datalad on git:ux-5731
❱ datalad wtf
# WTF
## configuration <SENSITIVE, report disabled by configuration>
## credentials 
  - keyring: 
    - active_backends: 
      - SecretService Keyring
      - PlaintextKeyring with no encyption v.1.0 at /home/adina/.local/share/python_keyring/keyring_pass.cfg
    - config_file: /home/adina/.config/python_keyring/keyringrc.cfg
    - data_root: /home/adina/.local/share/python_keyring
## datalad 
  - full_version: 0.14.4.dev496-g61bc
  - version: 0.14.4.dev496
## dataset 
  - branches: 
    - appveyor[@618f99e]
    - bf-4359[@b0a4458]
    - bf-flexibleclonecandidates[@73cbe11]
    - bf-git-gc[@9e17649]
    - doc-get[@d91c19e]
    - doc-joss[@5a49c20]
    - enh-addreadme[@96d0a68]
    - enh-addreadme2[@f53c74f]
    - enh-addreadmebackup[@f2deb2a]
    - get-command-annex-error[@8def465]
    - gh-loj[@0b0e7fe]
    - maint[@08f5c58]
    - master[@74f6f81]
    - non-interactive-log-wrap[@60e3edd]
    - rf-auto[@42052d6]
    - rf-callannex[@6c1a736]
    - test-5631[@580537c]
    - test-bf-flexibleclonecandidates[@686f27d]
    - tst-testrepos-appveyor[@dfa5ea5]
    - ux-5547[@8724226]
    - ux-5711[@be4b3c1]
    - ux-5731[@61bcf10]
    - ux-pushtarget[@a46f21e]
  - id: None
  - metadata: <SENSITIVE, report disabled by configuration>
  - path: /home/adina/repos/datalad
  - repo: GitRepo
## dependencies 
[...]

@adswa
Copy link
Member Author

adswa commented Jul 21, 2021

I haven't added any git described output yet (which @yarikoptic suggested in the original issue), though. Would that fit under a section tag, maybe?

@codecov
Copy link

codecov bot commented Jul 21, 2021

Codecov Report

Merging #5804 (dff563a) into master (97f055b) will decrease coverage by 2.04%.
The diff coverage is 100.00%.

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

@@            Coverage Diff             @@
##           master    #5804      +/-   ##
==========================================
- Coverage   90.64%   88.60%   -2.05%     
==========================================
  Files         309      306       -3     
  Lines       42436    42405      -31     
==========================================
- Hits        38468    37571     -897     
- Misses       3968     4834     +866     
Impacted Files Coverage Δ
datalad/local/tests/test_wtf.py 81.92% <100.00%> (-6.83%) ⬇️
datalad/local/wtf.py 83.64% <100.00%> (+0.12%) ⬆️
datalad/support/exceptions.py 85.12% <100.00%> (ø)
datalad/plugin/wtf.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/plugin/addurls.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/plugin/no_annex.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/plugin/add_readme.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/plugin/check_dates.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/support/tests/utils.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/plugin/export_archive.py 0.00% <0.00%> (-100.00%) ⬇️
... and 82 more

Continue to review full report at Codecov.

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

@adswa
Copy link
Member Author

adswa commented Jul 22, 2021

Appveyor failure is "Build execution time has reached the maximum allowed time for your plan (60 minutes)."

Copy link
Member

@mih mih left a comment

Choose a reason for hiding this comment

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

I like it! Thx!

I would even consider to not have the [ ], but simply append the @... to the branch name. But it works for me as-is too.

@adswa
Copy link
Member Author

adswa commented Jul 23, 2021

We could remove the [ ] - its potentially even easier then to grep for it. I can do after I finished my current work on #5812

Remove square brakets - could make automated extraction/grepping easier
Remove square brakets - could make automated extraction/grepping easier
@adswa
Copy link
Member Author

adswa commented Jul 23, 2021

I have removed [] and force-pushed

@mih
Copy link
Member

mih commented Jul 26, 2021

Cool, thanks. Let's merge this!

@mih mih merged commit 66bea22 into datalad:master Jul 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add information about current state and branches
2 participants