RELEASE_CHECKLIST.txt 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. Release checklist:
  2. release=0.13
  3. git clone https://github.com/json-c/json-c json-c-${release}
  4. cd json-c-${release}
  5. Check that the compile works on Linux
  6. Check that the compile works on NetBSD
  7. Check that the compile works on Windows
  8. Run "make distcheck" and fix any problems
  9. (e.g. adding new files to SOURCES variables in Makefile.am)
  10. Check ChangeLog to see if anything should be added.
  11. Make any fixes/changes *before* branching.
  12. git branch json-c-${release}
  13. git checkout json-c-${release}
  14. ------------
  15. Update the version in json_c_version.h
  16. Update the version in Doxyfile
  17. Update the version in configure.ac
  18. Update the version in CMakeLists.txt
  19. Use ${release}.
  20. Update the libjson_la_LDFLAGS line in Makefile.am to the new version.
  21. Generally, unless we're doing a major release, change:
  22. -version-info x:y:z
  23. to
  24. -version-info x:y+1:z
  25. ------------
  26. Generate the configure script and other files:
  27. sh autogen.sh
  28. git add -f Makefile.in aclocal.m4 config.guess config.h.in \
  29. config.sub configure depcomp install-sh \
  30. ltmain.sh missing tests/Makefile.in \
  31. INSTALL
  32. # check for anything else to be added:
  33. git status --ignored
  34. git commit
  35. ------------
  36. Generate the doxygen documentation:
  37. doxygen
  38. git add -f doc
  39. git commit doc
  40. ------------
  41. cd ..
  42. echo .git > excludes
  43. echo autom4te.cache >> excludes
  44. tar -czf json-c-${release}.tar.gz -X excludes json-c-${release}
  45. echo doc >> excludes
  46. tar -czf json-c-${release}-nodoc.tar.gz -X excludes json-c-${release}
  47. ------------
  48. Tag the branch:
  49. cd json-c-${release}
  50. git tag -a json-c-${release}-$(date +%Y%m%d) -m "Release json-c-${release}"
  51. git push origin json-c-${release}
  52. git push --tags
  53. ------------
  54. Go to Amazon S3 service at:
  55. https://console.aws.amazon.com/s3/
  56. Upload the two tarballs in the json-c_releases folder.
  57. When uploading, use "Reduced Redundancy", and make the uploaded files publicly accessible.
  58. Logout of Amazon S3, and verify that the files are visible.
  59. https://s3.amazonaws.com/json-c_releases/releases/index.html
  60. ===================================
  61. Post-release checklist:
  62. git checkout master
  63. Add new section to ChangeLog
  64. Update the version in json_c_version.h
  65. Update the version in Doxyfile
  66. Update the version in configure.ac
  67. Update the version in CMakeLists.txt
  68. Use ${release}.99 to indicate a version "newer" than anything on the branch.
  69. Leave the libjson_la_LDFLAGS line in Makefile.am alone.
  70. For more details see:
  71. http://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html
  72. ------------
  73. Update the gh-pages branch with new docs:
  74. cd json-c-${release}
  75. git checkout json-c-${release}
  76. cd ..
  77. git clone -b gh-pages https://github.com/json-c/json-c json-c-pages
  78. cd json-c-pages
  79. mkdir json-c-${release}
  80. cp -R ../json-c-${release}/doc json-c-${release}/.
  81. cp ../json-c-${release}/README-WIN32.html json-c-${release}/.
  82. git add json-c-${release}
  83. git commit
  84. vi index.html
  85. Add/change links to current release.
  86. git commit index.html
  87. git push
  88. ------------
  89. Update checksums on wiki page.
  90. cd ..
  91. openssl sha -sha256 json-c*gz
  92. openssl md5 json-c*gz
  93. Copy and paste this output into the wiki page at:
  94. https://github.com/json-c/json-c/wiki
  95. ------------
  96. Send an email to the mailing list.