Warning, /multimedia/amarok/release_scripts/SCRIPT_UPDATING_HOWTO is written in an unsupported language. File is not indexed.

0001 Script Updating HOWTO
0002 ===============================================================================
0003 
0004 This document describes how to release an update for a script that will be 
0005 deployed using Amarok's automatic script updating mechanism. 
0006 
0007 
0008 A. Quick step-by-step overview:
0009 
0010 * Have a look at the code you're about to deploy, to make sure it isn't 
0011     malicious ;-)
0012 * Check to make sure the version number in script.spec has been incremented
0013 * Create the archive "main.tar.bz2" and the "version" file (see B.3 for 
0014     details)
0015 * Create the signature (see B.4 above for details)
0016 * Put these three files into amarok.kde.org/scriptupdates/<script-name>/ (see 
0017     B.2 for details)
0018 
0019 
0020 B. Appendix: General specification:
0021 
0022 1. The base URL for the update repository is amarok.kde.org/scriptupdates/.
0023 
0024 2. Inside this directory, for each script there must be a subdirectory that is 
0025     spelled exactly like the script's directory when Amarok has been installed 
0026     (i.e. currently "librivox_service", "lyrics_lyricwiki", 
0027     "radio_station_service" and so on).
0028 
0029 3. Inside a script's subdirectory, three files are provided (in case there is 
0030     an update for this script):
0031     - "main.tar.bz2": the contents of the update, i.e. the full contents of the 
0032         script's directory (without the directory itself). Specifically, the 
0033         files "main.js" and "script.spec" (as well as any additional resources) 
0034         are directly inside the archive's root. 
0035     - "version": a plain text file specifying the version of the updated script. 
0036         Any combination of numbers and dots is supported as the version number. 
0037         The content of this file is compared by Amarok to the value of 
0038         X-KDE-PluginInfo-Version in the *installed* script's script.spec in 
0039         order to determine whether an update is available. 
0040     - "signature": the digital signature for both the main archive and the 
0041         "version" file. If this signature is missing or invalid, no update will 
0042         be performed. 
0043 
0044 4. In the utilities/updatesigner/ directory of the Amarok sources, there is a 
0045     tool for creating signatures (and key pairs), which is per default installed 
0046     to /usr/bin/amarok-update-signer. To create a signature, cd to the directory 
0047     where you put "main.tar.bz2" and "version", and run:
0048     $ amarok-update-signer sign /path/to/your/privkey.pem
0049     (or run amarok-update-signer without any parameters to get a usage 
0050     description). This will, after asking you for the key's passphrase,  create 
0051     the "signature" file. 
0052