GeneratingTheFullRelease - psiinon/zaproxy GitHub Wiki

Generating the full release

NOTE that this page is "work in progress" ;)

Generating the full release is currently a manual process.

Yes we should automate more, but as you'll see there are quite a few steps and manual sanity checks.

<relnum> is the release number, e.g. 2.4.1

Create a new release branch

  1. On the command line in zaproxy/zaproxy: git checkout -b release-<relnum> develop

You should now be working on the zaproxy/zaproxy "release-" branch.

Update for the new release

  1. Change the zaproxy/build/version.txt file to contain just <relnum>
  2. Generate a short URL (eg via https://bitly.com/) and update zaproxy/src/org/zaproxy/zap/extension/autoupdate/ExtensionAutoUpdate.java
  3. Commit and push the branch to zaproxy/zaproxy

Update @since

  1. Grep for "TODO add version" replace with the version number
  2. Commit and push

Create release help file

  1. Run GenerateReleaseNotes.java after updating the date
  2. Create the file in zaproxy/zap-core-help/src/help/zaphelp/contents/releases
  3. Update index.xml, map.jhm and toc.xml

Language files

  1. zap-admin/build/build.xml target=crowdin-update-sources
  2. zap-admin/build/build.xml target=crowdin-trigger-export-packages
  3. zap-admin/build/build.xml target=crowdin-download-translations
  4. zap-admin/build/build.xml target=generate-help-jars
  5. zapproxy/build/build.xml target=generate-language-file
  6. Refresh files in IDE
  7. Change the language file name, remove the old one, update the coreLang manifest
  8. Update the help manifests (if required)
  9. Commit changed language files (with some sanity checking)

Generate the java client API

  1. as per the weekly release process
  2. Update the Java API client version (in build.xml)

Update extension zap.jar files

  1. zaproxy/build/build.xml target=copy-jar-to-extension-projects
  2. Refresh files in IDE
  3. Fix any compilation errors caused by updating the jar
  4. Commit the jars and any fixes required

Generate the release add-ons

  1. zaproxy/build/build.xml target=deploy-release-addons

TODO FINISH ;)

⚠️ **GitHub.com Fallback** ⚠️