release.sh generates an addon zip file from a Git, SVN, or Mercurial checkout.
release.sh works by creating a new project directory, checking out external repositories within the project directory, then copying files from the checkout into the project directory. The project directory is then zipped to create a distributable addon zip file.
release.sh creates the new project directory in the .release subdirectory of the top-level directory of the checkout.
release.sh assumes that tags (Git annotated tags and SVN tags) are named for the version numbers for the project. It will identify if the HEAD is tagged and use that as the current version number. It will search back through parent commits for the previous tag and generate a changelog containing the commits since that tag.
release.sh uses the TOC file to determine the package name for the project.
You can also set the CurseForge project id (
-p) and the WoWInterface addon
-w) by adding the following to the TOC file:
## X-Curse-Project-ID: 1234 ## X-WoWI-ID: 5678
Your CurseForge project id can be found on the addon page in the "About Project" side box. Your WoWInterface addon id is in the url for the addon, eg, the "5678" in https://wowinterface.com/downloads/info5678-MyAddon.
release.sh reads .pkgmeta and supports the following directives. See the wiki page for more info.
- externals (Git, SVN, and Mercurial) Caveats: An external's .pkgmeta is only parsed for ignore and externals will not have localization keywords replaced.
- enable-nolib-creation (defaults to no) Caveats: nolib packages will only be uploaded to GitHub and attached to a release. Unlike using the Curse packager, manually uploading nolib packages has no affect for client users that choose to download libraries separately.
- embedded-libraries Note: All externals will be marked as embedded, overriding any manually set relations in the pkgmeta.
You can also use a few directives for WoWInterface uploading.
- wowi-archive-previous :
yes|no(defaults to yes) Archive the previous release.
- wowi-create-changelog :
yes|no(defaults to yes) Generate a Git changelog using BBCode that will be set when uploading. A manual changelog will always be used if set in the .pkgmeta. If you have pandoc installed, manual changelogs in Markdown format will be converted to BBCode; otherwise, the manual changelog will be used as-is.
release.sh supports the following repository substitution keywords when copying the files from the checkout into the project directory. See the wiki page for more info.
- @localization(locale="locale", format="format", ...)@
- @alpha@...@end-alpha@ / @non-alpha@...@end-non-alpha@
- @debug@...@end-debug@ / @non-debug@...@end-non-debug@
- @retail@...@end-retail@ / @non-retail@...@end-non-retail@
Build type keywords
alpha, debug, retail, no-lib-strip, and do-not-package are build type keywords and are used to conditionally run a block of code based on the build type with the use of comments.
@end-do-not-package@ are a bit special. Everything
between the tags, including the tags themselves, will be removed from the file.
This will cause the line numbers of subsequent lines to change, which can result
in bug report line numbers not matching the source code. The typical usage is
at the end of Lua files surrounding debugging functions and other code that end
users should never see or execute.
In Lua files
In XML files
Note: XML doesn't allow nested comments so make sure not to nest keywords. If you need nested keywords, you can do so in the TOC instead.
<!--@non-keyword@ and @end-non-keyword@-->
In TOC files
The lines with
#@end-keyword@ get removed, as well as every
The lines with
#@end-non-keyword@ get removed, as well as
removing a '# ' at the beginning of each line in-between.
The recommended way to include release.sh in a project is to:
- Create a .release subdirectory in your top-level checkout.
- Copy release.sh into the .release directory.
- Ignore the .release subdirectory in .gitignore.
- Run release.sh.
Using release.sh to build a Classic release
To make use of the
@non-retail@ keywords, release.sh needs
to know what version of World of Warcraft the package is targeting. This is
automatically detected using the
## Interface: line of the addon's TOC file.
If your addon supports both retail and classic in the same branch, you can use
keywords in your TOC file to include the appropriate
## Interface: line in the
#@retail@ ## Interface: 80300 #@end-retail@ #@non-retail@ # ## Interface: 11305 #@end-non-retail@
release.sh will target retail by default. You can change this by passing a
different game version as an argument. To target classic this would be
release.sh -g 1.13.5.
Usage: release.sh [-cdelLosuz] [-t topdir] [-r releasedir] [-p curse-id] [-w wowi-id] [-g game-version] [-m pkgmeta.yml] -c Skip copying files into the package directory. -d Skip uploading. -e Skip checkout of external repositories. -l Skip @localization@ keyword replacement. -L Only do @localization@ keyword replacement (skip upload to CurseForge). -o Keep existing package directory, overwriting its contents. -s Create a stripped-down "nolib" package. -u Use Unix line-endings. -z Skip zip file creation. -t topdir Set top-level directory of checkout. -r releasedir Set directory containing the package directory. Defaults to "$topdir/.release". -p curse-id Set the project id used on CurseForge for localization and uploading. (Use 0 to unset the TOC value) -w wowi-id Set the addon id used on WoWInterface for uploading. (Use 0 to unset the TOC value) -g game-version Set the game version to use for CurseForge uploading. -m pkgmeta.yaml Set the pkgmeta file to use.
The following environment variables are necessary for uploading:
CF_API_KEY- a CurseForge API token, required for the CurseForge API to fetch localization and upload files.
WOWI_API_TOKEN- a WoWInterface API token, required for uploading to WoWInterface.
GITHUB_OAUTH- a GitHub personal access token, required for uploading to GitHub.
release.sh will attempt to load environment variables from a
.env file in
the topdir or current working directory. You can also edit release.sh and
enter the tokens near the top of the file.