curseforge-packager's Introduction

release.sh

release.sh generates an addon zipfile from a Git or SVN 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 zipfile.

release.sh reads .pkgmeta and supports the following directives:

externals (Git and SVN)
ignore
license-output (for default All Rights Reserved license)
manual-changelog
move-folders
package-as

release.sh supports the following repository substitution keywords when copying the files from the checkout into the project directory.

@alpha@...@end-alpha@
@debug@...@end-debug@
@do-not-package@...@end-do-not-package@
@localization(locale="locale", format="format", ...)@
- escape-non-ascii
- handle-subnamespaces
- handle-unlocalized
- namespace
@no-lib-strip@...@end-no-lib-strip@
@non-alpha@...@end-non-alpha@
@non-debug@...@end-non-debug@
@project-revision@
@project-version@

release.sh reads the TOC file, if present, to determine the name of the project.

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 that is a release version number and generate a changelog containing the commits since that previous release tag.

By default, release.sh creates releases in a release subdirectory of the top-level directory of the checkout.