1. Introduction
2. Prerequisites
3. Setup
4. Usage
5. Further Information
The Teddy releaser app runs all tests and then creates the archive (.zip and .tgz) and checksum (SHA-256) files that must be attached to an official release of Teddy.
Please ensure that the following required software services are installed in your environment.
Clone the teddy-releaser repository to a directory of your choice. Navigate into this directory and ensure that the main branch is checked out. Then install the required dependencies using NPM as follows.
# Clone the teddy-releaser app.
git clone https://github.com/teddyful/teddy-releaser.git
# Navigate into teddy-releaser.
cd teddy-releaser
# Checkout the main branch (default).
git checkout main
# Install the required dependencies.
npm install
To build a release, run either npm run build or node build.js and provide the following mandatory command-line arguments.
The absolute path to the local Teddy repository that will be used to build a release of Teddy.
# Build a release of Teddy.
npm run build -- --repo /home/teddyful/teddy
_ _
( \---/ )
) . . (
____,--._(___Y___)_,--.____
`--' `--'
TEDDY
teddyful.com
___________________________
2025-03-11 14:51:31.860 [Teddy Releaser] INFO: Started the Teddy release builder app (v0.0.1).
2025-03-11 14:51:31.862 [Teddy Releaser] INFO: Teddy repo: /home/teddyful/teddy
2025-03-11 14:51:31.862 [Teddy Releaser] INFO: Building the release ...
2025-03-11 14:51:31.863 [Teddy Releaser] INFO: Stage 1 of 7 - Validating the repository...
2025-03-11 14:51:31.864 [Teddy Releaser] INFO: Stage 2 of 7 - Parsing the release version number...
2025-03-11 14:51:31.864 [Teddy Releaser] INFO: Stage 3 of 7 - Clearing the release directory...
2025-03-11 14:51:31.987 [Teddy Releaser] INFO: Stage 4 of 7 - Running tests...
2025-03-11 14:51:35.081 [Teddy Releaser] INFO: Stage 5 of 7 - Creating the release directory...
2025-03-11 14:51:35.082 [Teddy Releaser] INFO: Stage 6 of 7 - Creating archives...
2025-03-11 14:51:37.861 [Teddy Releaser] INFO: Stage 7 of 7 - Generating checksums...
2025-03-11 14:51:37.878 [Teddy Releaser] INFO: Successfully finished building the release!
2025-03-11 14:51:37.878 [Teddy Releaser] INFO: Release version number: 0.0.1
2025-03-11 14:51:37.879 [Teddy Releaser] INFO: Release build directory: ./releases/0.0.1
2025-03-11 14:51:37.879 [Teddy Releaser] INFO: Exiting the Teddy release builder app (exitCode = 0).
Run npm run build -- -h or node build.js -h to see a complete list of usage options.
The built release files will be created in teddy-releaser/releases/{version}, where {version} is extracted from {repo}/package.json, and consist of the following:
- teddy-{version}.tgz
- teddy-{version}.zip
- teddy-{version}-checksums.txt (SHA-256 and hex encoding)
Note that if any of the tests fail, then the release files will not be created.
For further information, please visit teddyful.com.