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.

Sign up for GitHub

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

Jump to bottom

Update release guide including about binder requirements #1205

Merged
merged 4 commits into from
Jul 27, 2021
Merged

Update release guide including about binder requirements #1205

merged 4 commits into from
Jul 27, 2021

Conversation

namurphy
Copy link
Member

This PR includes some updates to the release guide prior to 0.7.0, including some minor formatting and reST changes.

The main purpose is to follow up on #1159 by changing binder/requirements.txt such that binder installs the version of PlasmaPy that was just released. Some points:

  • I haven't tested this step yet, so we might need to update it after the release.
  • There might be a better place to put this step in the release guide.
  • This step could be automated, but even if so, we would want to keep a step where the binder notebooks are tested on both stable and the <major>.<minor>.x branch.

@github-actions github-actions bot added the docs PlasmaPy Docs at http://docs.plasmapy.org label Jul 23, 2021
@codecov
Copy link

codecov bot commented Jul 23, 2021 •
edited
Loading

Codecov Report

❗ No coverage uploaded for pull request base (main@aeab5d7). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1205   +/-   ##
=======================================
  Coverage        ?   96.98%           
=======================================
  Files           ?       71           
  Lines           ?     7030           
  Branches        ?        0           
=======================================
  Hits            ?     6818           
  Misses          ?      212           
  Partials        ?        0

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 aeab5d7...538ebcd. Read the comment docs.

@StanczakDominik
Copy link
Member

This step could be automated, but even if so, we would want to keep a step where the binder notebooks are tested on both stable and the ..x branch.

groans in test complexity

StanczakDominik
StanczakDominik approved these changes Jul 27, 2021
View reviewed changes
Copy link
Member

@StanczakDominik StanczakDominik left a comment

Choose a reason for hiding this comment

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

LGTM!

docs/development/release_guide.rst
@@ -29,16 +29,16 @@ Pre-release
Release
-------

* Reserve a digital object identifier (DOI) on `Zenodo`_ for version ``0.6.0``.
* Reserve a digital object identifier (DOI) on Zenodo_ for version ``0.6.0``.
Copy link
Member

Choose a reason for hiding this comment

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

And this works? Without the `s?

I've been catching up on Star Trek TOS recently and let me just say, fascinating.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yep! One of the many things I learned but never wanted to while working on #1156.

@StanczakDominik StanczakDominik merged commit 70f3228 into PlasmaPy:main Jul 27, 2021
@namurphy namurphy deleted the release-guide-binder branch September 10, 2021 00:56
@namurphy namurphy mentioned this pull request Aug 18, 2022
Closed
8 tasks
@namurphy namurphy added the release Related to releasing a new version of PlasmaPy label May 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StanczakDominik StanczakDominik StanczakDominik approved these changes

Assignees
No one assigned
Labels
contributor guide docs PlasmaPy Docs at http://docs.plasmapy.org release Related to releasing a new version of PlasmaPy
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@namurphy @StanczakDominik