Difference between revisions of "Update Release Notes"

From NST Wiki
Jump to navigationJump to search
(New page: The release notes at SourceForge will need to be created and or updated. In general, this involves the following: * Create the file: "''src/sf/sf-release-notes-${VERSION}.html''" (copy an...)
 
Line 24: Line 24:
 
   
 
   
 
  [root@nst-dev-32 sf]#
 
  [root@nst-dev-32 sf]#
 +
 +
= Modifying Release Notes =
 +
 +
At the time of the 2.11.0 release, it was very difficult to change the release notes file at SourceForge. Here's the process that seemed to work for us:
 +
 +
* Using the SourceForge file manager, remove any associations of other files with the release notes.
 +
* Using a '''sftp''' connection to SourceForge, remove the existing release notes file.
 +
* From the NST development box, upload the new version of the release notes document (''make release-notes-upload'').
 +
* Back in the SourceForge file manager set the ''Release Notes'' option under the file properties.
 +
* Back in the SourceForge file manager associate the new release notes with the other files.

Revision as of 21:07, 23 September 2009

The release notes at SourceForge will need to be created and or updated. In general, this involves the following:

  • Create the file: "src/sf/sf-release-notes-${VERSION}.html" (copy an existing file to use as a starting point).
  • Update the information contained in the file (MD5 sums, notes about the release, etc).
  • Upload the release notes to SourceForge.
  • Log into the SourceForge site and go to the file management area. Flag the newly uploaded file as a release notes document.
  • Edit the properties for the other files uploaded for the release and associate them with the release notes document.

Here's example of how one might create and upload the release notes:

[root@nst-dev-32 repo]# cd src/sf
[root@nst-dev-32 sf]# cp sf-release-notes-2.11.0.html sf-release-notes-2.12.0.html 
[root@nst-dev-32 sf]# emacs -nw sf-release-notes-2.12.0.html 

... Edit release notes HTML ...

[root@nst-dev-32 sf]# make release-notes-upload

... Output related to the transfer to SourceForge ...

[root@nst-dev-32 sf]#

Modifying Release Notes

At the time of the 2.11.0 release, it was very difficult to change the release notes file at SourceForge. Here's the process that seemed to work for us:

  • Using the SourceForge file manager, remove any associations of other files with the release notes.
  • Using a sftp connection to SourceForge, remove the existing release notes file.
  • From the NST development box, upload the new version of the release notes document (make release-notes-upload).
  • Back in the SourceForge file manager set the Release Notes option under the file properties.
  • Back in the SourceForge file manager associate the new release notes with the other files.