Skip to content

How to make a new ripme release

metaprime edited this page Apr 15, 2025 · 3 revisions

Publishing a New Release

(These instructions are a work in progress.)

Create the Release

edit draft release development build main the following way:

  1. Go to https://github.com/RipMeApp/ripme/releases/tag/latest-main and click "edit"
  2. In git create a new tag with version from ripme filename, e.g. 2.1.12-7-d0b97acd, and push it to the repo
  3. Refresh the draft release page to pick up the new tag you pushed in the tags drop-down menu
  4. set the tag to the tag you just created and set the previous tag to the previous release tag before, e.g. 2.1.11-20-ca96ce88
  5. set the title to same name as the tag (like previous releases)
  6. press generate release notes button
  7. edit release text as appropriate
  8. save

Another version of instructions that worked for @metaprime:

  • Push latest-main to the version you will want to publish, and wait a few minutes for automation to finish running the build
  • Go to https://github.com/RipMeApp/ripme/releases/tag/latest-main and click "edit"
  • Note the version in the filename for the .jar
  • In git, create and push a tag with that version number
  • Update the tag on the release to that version numbered tag that matches the .jar's name
  • Change the title on the release to match
  • Uncheck "set as a pre-release"
  • Check "set as the latest release"
  • Click "publish release"

Publish the JSON update so the update check will pick up the new release

then, prepare the repo for update check, and next release:

  1. edit ripme.json, enter new hash, version and short description, and commit
    1. Get the hash by downloading the file and computing a sha256 hash
  2. set the base tag for next release version calculation, e.g. 2.1.13 on this commit
  3. push tag and commit
  4. remove old base tag, not needed any more, e.g. 2.1.12

Previous Instructions (2018 and before)

Note: To make a new ripme release you must have write access to ripmeapp/ripme and have a github api token

Step 1: Update your local copy of ripme with git pull origin master

Step 2: Run patch.py. This script will prompt you for a list of changes (separated with a ;) since the last release and then update ripmes version number in a few places and append the list of changes you entered to the change log in ripme.json and commits these changes

Step 3: Run git push origin master to update the remote copy of ripme

Step 4: Run release.py. This script has several flags 2 of which are needed to push a new release, these being --file (the path to the jar built by patch.py in step 2, this is normally in target/.) and --token (Your github api token). This will make and publish the new release

Warning: The jar you are releasing must be in target/ or release.py will crash