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

Notes on how to do a release #360

Merged
merged 4 commits into from Mar 15, 2018

Conversation

Projects
None yet
3 participants
@Titan-C
Member

Titan-C commented Mar 12, 2018

In reply to #344, this are my notes on how to prepare a release of sphinx-gallery

@codecov-io

This comment has been minimized.

codecov-io commented Mar 12, 2018

Codecov Report

Merging #360 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #360   +/-   ##
=======================================
  Coverage   92.08%   92.08%           
=======================================
  Files          27       27           
  Lines        1844     1844           
=======================================
  Hits         1698     1698           
  Misses        146      146

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 248f504...fc8dd55. Read the comment docs.

@lesteve

Thanks a lot for this. I changed the file to a .rst and moved it to the the doc folder. A few comments about things I am not sure about. Other than that, I think this is a good first step and can be improved when we do the next release.

.. code-block:: bash
python setup.py sdist upload

This comment has been minimized.

@lesteve

lesteve Mar 13, 2018

Contributor

Why not use twine here?

This comment has been minimized.

@Titan-C

Titan-C Mar 13, 2018

Member

I don't remember anymore. We can try twine again.

Make sure to clean all and have a clean build. Double-check visually that
everything looks right.
* Do Signed release commit

This comment has been minimized.

@lesteve

lesteve Mar 13, 2018

Contributor

I am not sure what you mean by this. Do you mean tag (you have not mentioned tag anywhere else)?

This comment has been minimized.

@Titan-C

Titan-C Mar 13, 2018

Member

I mean have the commit for the release be GPG signed. So that it shows in github as verified commit. I have seen many projects that sign their releases.

Regarding the tag. I don't tag the commit. I actually use the github web interphase to do the release, put the annotations and summary of the release, when you do that github puts the tag.

This comment has been minimized.

@lesteve

lesteve Mar 13, 2018

Contributor

Interesting, I did not know that.

lesteve added some commits Mar 15, 2018

@lesteve lesteve force-pushed the Titan-C:release_manual branch from 73d2868 to fc8dd55 Mar 15, 2018

@lesteve

This comment has been minimized.

Contributor

lesteve commented Mar 15, 2018

I pushed some minor tweaks, I am going to merge this one like this. This can be improved next time we do a release.

@lesteve

This comment has been minimized.

Contributor

lesteve commented Mar 15, 2018

Merging thanks a lot @Titan-C!

@lesteve lesteve merged commit b5cd22b into sphinx-gallery:master Mar 15, 2018

0 of 3 checks passed

ci/circleci CircleCI is running your tests
Details
continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

@lesteve lesteve deleted the Titan-C:release_manual branch Mar 15, 2018

@Titan-C Titan-C referenced this pull request Jun 5, 2018

Closed

v0.1.14 release plan #344

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