Source Release For hyrax-dependencies: Difference between revisions

From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
No edit summary
Line 1: Line 1:


; Prerequisite
This task is to ensure that the ''hyrax-dependencies'' project is up to date and tar balls on www.o.o. are current.
: ''Make sure the ''hyrax-dependencies'' project is up to date and tar balls on www.o.o. If there have been changes/updates since the last Hyrax release.''


=== Update Release Files ===
== Update ChangeLog, NEW, and release version ==
Update the text documentation files and version numbers
=== Update the '''ChangeLog''' file. ===
 
==== Update the '''ChangeLog''' file. ====
Use the script <tt>gitlog-to-changelog</tt> (which can be found with Google) to update the '''ChangeLog''' file by running it using the <tt>--since="<date>"</tt> option with a date one day later in time than the newest entry in the current ChangeLog.  
Use the script <tt>gitlog-to-changelog</tt> (which can be found with Google) to update the '''ChangeLog''' file by running it using the <tt>--since="<date>"</tt> option with a date one day later in time than the newest entry in the current ChangeLog.  
: '''gitlog-to-changelog --since="1970-01-01"''' (''Specify a date one day later than the one at the top of ChangeLog'')
: '''gitlog-to-changelog --since="1970-01-01"''' (''Specify a date one day later than the one at the top of ChangeLog'')
Line 14: Line 11:
'''Tip''': ''When you're making the commit log entries, use line breaks so ChangeLog will be readable. That is, use lines < 80 characters long.''
'''Tip''': ''When you're making the commit log entries, use line breaks so ChangeLog will be readable. That is, use lines < 80 characters long.''


==== Update the NEWS file ====
=== Update the Version Numbers ===
To update the NEWS file, just read over the new ChangeLog entries and summarize.
If the review of the ChangeLog indicates that there have been changes since the last release, increment the version number in the Makefile.  


==== Update the Version Numbers ====
Make sure any change in version number is also reflected in the NEWS file.
If the review of the ChangeLog indicates that there have been changes since the last release, increment the version number in the Makefile. Make sure this change in version number is also reflected in the NEWS file.


=== Update the NEWS file ===
To update the NEWS file, just read over the new ChangeLog entries and summarize.


== Commit and Push ==
# Save, commit, and push the changes to master branch.
# Once the ''hyrax-dependencies'' CI build is finished
## Trigger a CI build ''libdap4'' by pushing a small change to the ''libdap4'' master branch. When that CI build has completed successfully,
## Trigger a CI build in the ''bes'' by pushing a small change to the ''bes'' master branch.
# Wait for the successful completion.


 
== Tag The Release ==
 
# Update version number for the ''hyrax-dependencies'' in the Makefile, for example "1.xx"
# Save, commit, and push the changes to master branch.
# Once the ''hyrax-dependencies'' CI build is finished, trigger builds CI in both ''libdap4'' and ''bes'' by pushing change(s) to the master branch of each.
# Tag, and push the tag.  
# Tag, and push the tag.  
#* ''git tag -m "version-<number>" -a <numbers>''  
#* ''git tag -m "version-<number>" -a <numbers>''  

Revision as of 15:23, 7 January 2022

This task is to ensure that the hyrax-dependencies project is up to date and tar balls on www.o.o. are current.

Update ChangeLog, NEW, and release version

Update the ChangeLog file.

Use the script gitlog-to-changelog (which can be found with Google) to update the ChangeLog file by running it using the --since="<date>" option with a date one day later in time than the newest entry in the current ChangeLog.

gitlog-to-changelog --since="1970-01-01" (Specify a date one day later than the one at the top of ChangeLog)

Save the result to a temp file and combine the two files:

cat tmp ChangeLog > ChangeLog.tmp; mv ChangeLog.tmp ChangeLog

If you're making the first ChangeLog entries, then you'll need to create the ChangeLog file first.
Tip: When you're making the commit log entries, use line breaks so ChangeLog will be readable. That is, use lines < 80 characters long.

Update the Version Numbers

If the review of the ChangeLog indicates that there have been changes since the last release, increment the version number in the Makefile.

Make sure any change in version number is also reflected in the NEWS file.

Update the NEWS file

To update the NEWS file, just read over the new ChangeLog entries and summarize.

Commit and Push

  1. Save, commit, and push the changes to master branch.
  2. Once the hyrax-dependencies CI build is finished
    1. Trigger a CI build libdap4 by pushing a small change to the libdap4 master branch. When that CI build has completed successfully,
    2. Trigger a CI build in the bes by pushing a small change to the bes master branch.
  3. Wait for the successful completion.

Tag The Release

  1. Tag, and push the tag.
    • git tag -m "version-<number>" -a <numbers>
    • git push origin <numbers>
  2. Since this is part of Hyrax, also tag this point in the master branch with the Hyrax release number:
    • git tag -m "hyrax-<number>" -a hyrax-<numbers>
    • git push origin hyrax-<numbers>
  3. Make 'release' in github
    1. Goto the GitHub 'tags' page for hyrax-dependencies.
    2. Enter a title for the release (looks at previous releases for examples)
    3. Copy the most recent text from the NEWS file into the describe field
    4. Click Update this release or Save draft, this will trigger a 'archive and DOI' process on the Zenodo system.
Retrieved from "https://docs.opendap.org/index.php?title=Source_Release_For_hyrax-dependencies&oldid=13223"