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

NXDL release 2020.1 #693

Closed
prjemian opened this issue Nov 8, 2019 · 11 comments
Closed

NXDL release 2020.1 #693

prjemian opened this issue Nov 8, 2019 · 11 comments
Assignees
Milestone

Comments

@prjemian
Copy link
Contributor

@prjemian prjemian commented Nov 8, 2019

Follow the documented release procedure. Someone other than @prjemian should do this to test that procedure has been fully documented.

These steps:

  • rename the NXDL 2019.10 milestone to NXDL 2020.1
  • identify and resolve existing issues which can be completed before release during the code camp
  • reassign unresolved issues to next milestone
  • follow release procedure
  • apply lessons learned to release procedure

Note: Any new issues will be assigned to next milestone after this code camp unless they are of immediate nature.

@prjemian

This comment has been minimized.

Copy link
Contributor Author

@prjemian prjemian commented Jan 28, 2020

@PeterC-DLS

There's a checklist at the top of this issue. Perhaps that should become part of the release procedures on the wiki? We're at step 2 on that checklist.

I'm looking at the work queue for the milestone and expecting that most remaining PRs will be complete by Thursday. Now that the release notes scripting is repaired (#735) but work remains to be merged, it's a good time to work the release process again with another R tag: v2020.1rc2.

@prjemian

This comment has been minimized.

Copy link
Contributor Author

@prjemian prjemian commented Jan 28, 2020

Each of the remaining PRs is waiting on one or more reviews. I sent messages to each reviewer yesterday with a request to review by COB Thursday. In one of them, I stated I want to release on Friday. Any unreviewed items will move to next milestone.

@PeterC-DLS

This comment has been minimized.

Copy link
Contributor

@PeterC-DLS PeterC-DLS commented Jan 28, 2020

Ok, I have completed the process for rc2. Please check all it okay.

@prjemian

This comment has been minimized.

Copy link
Contributor Author

@prjemian prjemian commented Jan 28, 2020

One addition is to link to the release notes from the tag comment. See https://github.com/nexusformat/definitions/releases/tag/v2018.5 for an example.

Release notes look good.

Updating the Change History needs to be added to the Release Procedure. The existing page refers to 2019.10 release that should be changed into v2020.1. The contents are hand-selected highlights from the release notes (since important items might be overlooked in the complete release notes).

Fantastic! On Friday, you can do the final release of v2020.1 after completing the checklist above.

Lessons learned

  • need linux OS for release process

  • need latexmf installed with certain additional fonts

    On Ubuntu xenial, the following packages need to be installed for successful PDF builds:
    texlive-latex-recommended
    texlive-fonts-recommended
    texlive-latex-extra
    latexmk (this is a Sphinx requirement on GNU/Linux and MacOS X for functioning of make latexpdf)

  • can build complete (HTML& PDF) manual with make all in root directory

Anything else?

@prjemian

This comment has been minimized.

Copy link
Contributor Author

@prjemian prjemian commented Jan 28, 2020

@PeterC-DLS

This comment has been minimized.

Copy link
Contributor

@PeterC-DLS PeterC-DLS commented Jan 28, 2020

On Fedora 31, need to install:

  • make hdf5-devel python-matplotlib python-lxml python3-sphinx-latex latexmk
  • h5py=2.10.0
  • pyRestTable
  • pygithub
  • sphinx==2.3.1
@prjemian

This comment has been minimized.

Copy link
Contributor Author

@prjemian prjemian commented Jan 31, 2020

@PeterC-DLS we are ready now for release v2020.1

@prjemian

This comment has been minimized.

Copy link
Contributor Author

@prjemian prjemian commented Jan 31, 2020

I just checked off items 2 & 3 in the check list above.

@PeterC-DLS

This comment has been minimized.

Copy link
Contributor

@PeterC-DLS PeterC-DLS commented Jan 31, 2020

Ok, I will proceed with release.

@PeterC-DLS

This comment has been minimized.

Copy link
Contributor

@PeterC-DLS PeterC-DLS commented Jan 31, 2020

All done up to and including step 13 so please check. I will be off-line so I will leave the last two steps to you.

@prjemian

This comment has been minimized.

Copy link
Contributor Author

@prjemian prjemian commented Jan 31, 2020

@prjemian prjemian closed this Feb 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.