Versions Compared

Old Version 74

changes.mady.by.user Robin Taylor

Saved on

compared with

New Version 75

changes.mady.by.user Robin Taylor

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Preface - Should contain a very basic overview of the Release. Make sure the Release number is updated here!
    • NOTE: For Subminor releases (bug-fix-only releases), you may want to leave all information about the previous major release, and just enhance the content to state that this was a bug-fix release, and list any new contributors, etc.
  • Installation - Obviously make sure the Installation Documentation is updated for this Release
  • Upgrading a DSpace Installation - Same for the Upgrade Documentation, make sure it's up to date
    Note

    Obviously, this is just a brief reminder of important areas of Documentation which always require updates. There's surely other areas, like Configuration, which will require some updates for your release.

Ensure

...

PDF

...

version of Wiki Documentation is in SVN

Make sure the latest Wiki-based Documentation has been exported as HTML and PDF and committed to [dspace-src]/dspace/docs/ in SVN.

Info
titleHow to Generate PDF & HTML Documentation

See this DSpace documentation management guide: How To Export Downloadable Docs from Wiki

Note
titleWatch for conflicts when updating HTML Documentation in SVN

It's often easier to completely remove all current HTML content before committing the updated HTML content. Because of the HTML directory structure exported by Confluence, it can be very difficult to determine which files need removing (especially old attachments). So, you may want to completely remove the old HTML directory, before committing the updated content. An example follows:

  1. Delete old HTML docs: e.g. svn delete http://scm.dspace.org/svn/repo/dspace/trunk/dspace/docs/html (Or delete from branch, as appropriate)
  2. Update your checked-out copy of Trunk/Branch: svn up
  3. Wiki Markup
    Locally, recreate the {{\[dspace-source\]/dspace/docs/html/}} in your checked out copy of Trunk/Branch
  4. Wiki Markup
    Copy new HTML docs to {{\[dspace-source\]/dspace/docs/html/}}, so that the {{index.html}} file is at {{html/index.html}}
  5. Commit new docs back to SVN

Double Check Contents of all README (and similar) files in SVN

Make sure that the contents of all README, LICENSE, NOTICE files are up-to-date in SVN. Most of these files exist in one of two main locations:

  1. [dspace-src]
    • includes LICENSE, NOTICE and README files
  2. [dspace-src]/dspace/
    • includes CHANGES, KNOWN_BUGS, LICENSE, NOTICE and README files

Double Check Contents of all README (and similar) files in SVN

Make sure that the contents of all README, LICENSE, NOTICE files are up-to-date in SVN. These files reside in [dspace-src. If anything is out-of-date, make sure to update it and commit the proper changes before continuing.

Checkout Trunk or Branch to Release

Checkout a copy of the to-be-release version either from a branch or trunk.

Code Block
svn co https://scm.dspace.org/svn/repo/dspace/trunk dspace-release

Do a Dry Run

Wiki Markup
This step is not required, but performs a useful sanity check without committing any changes.  From your clean, up-to-date copy of trunk/branch, run the following command (from {{\[dspace-src\]}}):

Code Block
mvn release:prepare -DdryRun=true

You will have to enter in your GPG passphrase (which you established when you created your Code Signing Key).

Info
If you need to re-run the Dry Run
If you need to re-run the Dry Run

If you notice an issue or an error occurs, you can re-run the Dry Run using the following command:

  • mvn release:prepare -DdryRun=true -Dresume=false

...