Skip to content

Creating a Processing Release

Damien Di Fede edited this page May 31, 2017 · 2 revisions
  • Review all examples included in the release to make sure they work with the most recent version of Processing. Fix any errors.

  • Update changelog.txt

  • Update library.properties (include info about what's in the update in the paragraph text)

  • Update the download links in the documentation index (package.html in src/ddf/minim)

  • Generate the documentation folder by running the 'doc' Ant task

  • Export the repository and prune out the stuff that should not be included in the release (could automate this using a bash script and git archive). As of writing the release should contain:

    changelog.txt
    /documentation
    /examples
    //Advanced
    //Analysis
    //AudioPlayer
    //Basics
    //Synthesis
    /library
    library.properties
    license.txt
    README.md
    /src

  • Zip up the contents of the release into a file named minim-X.X.X.zip

  • Upload the zip to the distro folder on the web.

  • Upload the documentation folder to the web

  • Upload the javadoc folder to the web

  • Replace minim_for_processing.zip in the distro folder with a copy of the new zip, but need to make sure the zip file creates a folder named 'minim' when it unpacks, otherwise it will not properly overwrite the older version in a user's libraries folder. To do this on Mac I had to take the unpacked release archive, rename the folder to 'minim' and the compress it to a new zip file. Simply duplicating and renaming the release zip file did not work.

  • Update the contents of minim_for_processing.txt in the distro folder to match library.properties

  • Verify that the Processing 3.0 library tool reports the new version and install it to make sure everything works as intended (they have a script that runs every day that updates a txt file on their website, so will need to wait a day to see the update in the library tool)

  • Create a new Release on GitHub, the description should probably include the same paragraph from library.properties

  • Blog / tweet about the release

  • Have a beer / wonder how much of this could be automated with a script

Clone this wiki locally