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

About plugin #2886

Merged
merged 6 commits into from
May 24, 2024
Merged

About plugin #2886

merged 6 commits into from
May 24, 2024

Conversation

pllim
Copy link
Contributor

@pllim pllim commented May 22, 2024

Description

This pull request is to add a new plugin to let user know which Jdaviz version, etc.

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)? 🐱

@pllim pllim added this to the 4.0 milestone May 22, 2024
@github-actions github-actions bot added cubeviz specviz mosviz imviz plugin Label for plugins common to multiple configurations specviz2d labels May 22, 2024
@pllim
Copy link
Contributor Author

pllim commented May 22, 2024

I feel like we don't need user-facing doc since this plugin is purely informational and should be pretty self-explanatory.

Copy link

codecov bot commented May 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.72%. Comparing base (1bce2b2) to head (95eca4c).
Report is 175 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2886      +/-   ##
==========================================
+ Coverage   88.69%   88.72%   +0.02%     
==========================================
  Files         109      111       +2     
  Lines       17047    17081      +34     
==========================================
+ Hits        15120    15155      +35     
+ Misses       1927     1926       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pllim pllim force-pushed the help-me-help-you branch from f705caa to 4f09759 Compare May 22, 2024 18:04
@pllim pllim force-pushed the help-me-help-you branch from 4f09759 to 626f014 Compare May 22, 2024 18:15
@pllim pllim marked this pull request as ready for review May 22, 2024 20:47
Copy link
Member

@kecnry kecnry 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! We can always add other version information or parse and show the changelog directly as potential future follow-ups. Just had two small considerations.

jdaviz/configs/default/plugins/about/about.vue Outdated Show resolved Hide resolved
jdaviz/configs/default/plugins/about/about.vue Outdated Show resolved Hide resolved
Co-authored-by: Kyle Conroy <kyleconroy@gmail.com>
@camipacifici
Copy link
Contributor

Love it!! Great job!
Is it normal that mine complains about 3.10.dev123?
Screenshot 2024-05-23 at 11 19 45 PM

@pllim
Copy link
Contributor Author

pllim commented May 24, 2024

Is it normal that mine complains about 3.10.dev123?

No, but it is also not a problem with the plugin. Whoever released 3.10.0 didn't tag a 3.11.dev. A dev tag is needed when we release from a release branch and not main. Though by now, should we just tag a 4.0.dev, @kecnry ?

@pllim
Copy link
Contributor Author

pllim commented May 24, 2024

I just tagged a v3.11.dev if you git pull upstream --tags and re-install, you should now see a 3.11.dev29+g930125f4. Please do that and see if the PyPI warning goes away for you. Thanks!

@camipacifici
Copy link
Contributor

Does not complain anymore!
I am not a reviewer but you can consider this an approval.

@pllim
Copy link
Contributor Author

pllim commented May 24, 2024

I think @gibsongreen said he was reviewing this. Maybe I should wait for his approval too.

Copy link
Collaborator

@rosteen rosteen left a comment

Choose a reason for hiding this comment

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

Cool feature! Approved, your choice to accept my suggestion or not.

Copy link
Contributor

@gibsongreen gibsongreen left a comment

Choose a reason for hiding this comment

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

I really like this addition to GUI, nice design and very useful, great work!

Just one consideration, I know the plugin is titled About, and it might be overkill since we have the documentation link elsewhere in the GUI, but I could see first time users finding the link in this plugin beneficial.

Also, love thehe branch name 😌

pllim and others added 3 commits May 24, 2024 10:56
Co-authored-by: Ricky O'Steen <39831871+rosteen@users.noreply.github.com>
as Gilbert suggested
@pllim pllim enabled auto-merge (squash) May 24, 2024 18:22
@pllim
Copy link
Contributor Author

pllim commented May 24, 2024

For full disclosure, this also introduces requests as required dependency, but it is already pulled in by astroquery that is already required, so does not matter in the end.

@pllim pllim merged commit 0b11723 into spacetelescope:main May 24, 2024
16 checks passed
@pllim pllim deleted the help-me-help-you branch May 24, 2024 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants