mirror of
https://github.com/jellyfin/jellyfin.git
synced 2026-06-03 22:38:30 +01:00
Add new centralized build script and README
This commit is contained in:
Joshua Boniface
@@ -1,8 +1,105 @@
|
||||
# Build scripts
|
||||
# Jellyfin Packaging
|
||||
|
||||
All `build.sh` and `package.sh` scripts are for *nix platforms (or WSL on Windows 10).
|
||||
This directory contains the packaging configuration of Jellyfin for multiple platforms. The specification is below; all package platforms must follow the specification to be compatable with the central `build` script.
|
||||
|
||||
After running both, check the `*/pkg-dist/` folders for the archives and packages.
|
||||
## Package List
|
||||
|
||||
### Operating System Packages
|
||||
|
||||
* `debian-package-x64`: Package for Debian and Ubuntu amd64 systems.
|
||||
* `fedora-package-x64`: Package for Fedora, CentOS, and Red Hat Enterprise Linux amd64 systems.
|
||||
|
||||
### Portable Builds (archives)
|
||||
|
||||
* `debian-x64`: Portable binary archive for Debian amd64 systems.
|
||||
* `ubuntu-x64`: Portable binary archive for Ubuntu amd64 systems.
|
||||
* `linux-x64`: Portable binary archive for generic Linux amd64 systems.
|
||||
* `osx-x64`: Portable binary archive for MacOS amd64 systems.
|
||||
* `win-x64`: Portable binary archive for Windows amd64 systems.
|
||||
* `win-x86`: Portable binary archive for Windows i386 systems.
|
||||
|
||||
### Other Builds
|
||||
|
||||
These builds are not necessarily run from the `build` script, but are present for other platforms.
|
||||
|
||||
* `framework`: Compiled `.dll` for use with .NET Core runtime on any system.
|
||||
* `docker`: Docker manifests for auto-publishing.
|
||||
* `unraid`: unRaid Docker template; not built by `build` but imported into unRaid directly.
|
||||
* `win-generic`: Portable binary for generic Windows systems.
|
||||
|
||||
## Package Specification
|
||||
|
||||
### Action Scripts
|
||||
|
||||
* Actions are defined in BASH scripts with the name `<action>.sh` within the framework directory.
|
||||
|
||||
* The list of valid actions are:
|
||||
|
||||
1. `build`: Builds a set of binaries.
|
||||
2. `package`: Assembles the compiled binaries into a package.
|
||||
3. `sign`: Performs signing actions on a package.
|
||||
4. `publish`: Performs a publishing action for a package.
|
||||
5. `clean`: Cleans up any artifacts from the previous actions.
|
||||
|
||||
* All package actions are optional, however at least one should generate output files, and any that do should contain a `clean` action.
|
||||
|
||||
* Actions are executed in the order specified above, and later actions may depend on former actions.
|
||||
|
||||
* Actions except for `clean` should `set -o errexit` to terminate on failed actions.
|
||||
|
||||
* The `clean` action should always `exit 0` even if no work is done or it fails.
|
||||
|
||||
### Output Files
|
||||
|
||||
* Upon completion of the defined actions, at least one output file must be created in the `<platform>/pkg-dist` directory.
|
||||
|
||||
* Output files will be moved to the directory `jellyfin-build/<platform>` one directory above the repository root upon completion.
|
||||
|
||||
### Common Functions
|
||||
|
||||
* A number of common functions are defined in `deployment/common.build.sh` for use by platform scripts.
|
||||
|
||||
* Each action script should import the common functions to define a number of standard variables.
|
||||
|
||||
* The common variables are:
|
||||
|
||||
* `ROOT`: The Jellyfin repostiory root, usually `../..`.
|
||||
* `CONFIG`: The .NET config, usually `Release`.
|
||||
* `DOTNETRUNTIME`: The .NET `--runtime` value, platform-dependent.
|
||||
* `OUTPUT_DIR`: The intermediate output dir, usually `./dist/jellyfin_${VERSION}`.
|
||||
* `BUILD_CONTEXT`: The Docker build context, usually `../..`.
|
||||
* `DOCKERFILE`: The Dockerfile, usually `Dockerfile` in the platform directory.
|
||||
* `IMAGE_TAG`: A tag for the built Docker image.
|
||||
* `PKG_DIR`: The final binary output directory for collection, invariably `pkg-dist`.
|
||||
* `ARCHIVE_CMD`: The compression/archive command for release archives, usually `tar -xvzf` or `zip`.
|
||||
|
||||
#### `get_version`
|
||||
|
||||
Reads the version information from `SharedVersion.cs`.
|
||||
|
||||
**Arguments:** `ROOT`
|
||||
|
||||
#### `build_jellyfin`
|
||||
|
||||
Build a standard self-contained binary in the current OS context.
|
||||
|
||||
**Arguments:** `ROOT` `CONFIG` `DOTNETRUNTIME` `OUTPUT_DIR`
|
||||
|
||||
#### `build_jellyfin_docker`
|
||||
|
||||
Build a standard self-contained binary in a Docker image.
|
||||
|
||||
**Arguments:** `BUILD_CONTEXT` `DOCKERFILE` `IMAGE_TAG`
|
||||
|
||||
#### `clean_jellyfin`
|
||||
|
||||
Clean up a build for housekeeping.
|
||||
|
||||
**Arguments:** `ROOT` `CONFIG` `OUTPUT_DIR` `PKG_DIR`
|
||||
|
||||
#### `package_portable`
|
||||
|
||||
Produce a compressed archive.
|
||||
|
||||
**Arguments:** `ROOT` `OUTPUT_DIR` `PKG_DIR` `ARCHIVE_CMD`
|
||||
|
||||
`build_all.sh` will invoke every build and package script.
|
||||
Use `collect_all.sh` to copy all artifact to one directory for easy uploading.
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -e
|
||||
|
||||
# Execute every clean.sh scripts in every folder.
|
||||
echo "Running for platforms '$@'."
|
||||
for directory in */ ; do
|
||||
platform=`basename "${directory}"`
|
||||
if [[ $@ == *"$platform"* || $@ = *"all"* ]]; then
|
||||
echo "Processing ${platform}"
|
||||
pushd "$platform"
|
||||
if [ -f clean.sh ]; then
|
||||
echo ./clean.sh
|
||||
fi
|
||||
popd
|
||||
else
|
||||
echo "Skipping $platform."
|
||||
fi
|
||||
done
|
||||
|
||||
rm -rf ./collect-dist
|
||||
@@ -1,20 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
source common.build.sh
|
||||
|
||||
VERSION=`get_version ..`
|
||||
|
||||
COLLECT_DIR="./collect-dist"
|
||||
|
||||
mkdir -p ./collect-dist
|
||||
|
||||
DIRS=`find . -type d -name "pkg-dist"`
|
||||
|
||||
while read directory
|
||||
do
|
||||
echo "Collecting everything from '$directory'.."
|
||||
PLATFORM=$(basename "$(dirname "$directory")")
|
||||
# Copy all artifacts with extensions tar.gz, deb, exe, zip, rpm and add the platform name to resolve any duplicates.
|
||||
find $directory \( -name "jellyfin*.tar.gz" -o -name "jellyfin*.deb" -o -name "jellyfin*.rpm" -o -name "jellyfin*.zip" -o -name "jellyfin*.exe" \) -exec sh -c 'cp "$1" "'${COLLECT_DIR}'/jellyfin_'${PLATFORM}'_${1#*jellyfin}"' _ {} \;
|
||||
|
||||
done <<< "${DIRS}"
|
||||
@@ -16,6 +16,16 @@ DEFAULT_OUTPUT_DIR="dist/jellyfin-git"
|
||||
DEFAULT_PKG_DIR="pkg-dist"
|
||||
DEFAULT_DOCKERFILE="Dockerfile"
|
||||
DEFAULT_IMAGE_TAG="jellyfin:"`git rev-parse --abbrev-ref HEAD`
|
||||
DEFAULT_ARCHIVE_CMD="tar -xvzf"
|
||||
|
||||
# Parse the version from the AssemblyVersion
|
||||
get_version()
|
||||
(
|
||||
local ROOT=${1-$DEFAULT_ROOT}
|
||||
grep "AssemblyVersion" ${ROOT}/SharedVersion.cs \
|
||||
| sed -E 's/\[assembly: ?AssemblyVersion\("([0-9\.]+)"\)\]/\1/' \
|
||||
| sed -E 's/.0$//'
|
||||
)
|
||||
|
||||
# Run a build
|
||||
build_jellyfin()
|
||||
@@ -77,19 +87,13 @@ clean_jellyfin()
|
||||
fi
|
||||
)
|
||||
|
||||
# Parse the version from the AssemblyVersion
|
||||
get_version()
|
||||
(
|
||||
local ROOT=${1-$DEFAULT_ROOT}
|
||||
grep "AssemblyVersion" ${ROOT}/SharedVersion.cs | sed -E 's/\[assembly: ?AssemblyVersion\("([0-9\.]+)"\)\]/\1/' | sed -E 's/.0$//'
|
||||
)
|
||||
|
||||
# Packages the output folder into an archive.
|
||||
package_portable()
|
||||
(
|
||||
local ROOT=${1-$DEFAULT_ROOT}
|
||||
local OUTPUT_DIR=${2-$DEFAULT_OUTPUT_DIR}
|
||||
local PKG_DIR=${3-$DEFAULT_PKG_DIR}
|
||||
local ARCHIVE_CMD=${4-$DEFAULT_ARCHIVE_CMD}
|
||||
# Package portable build result
|
||||
if [ -d ${OUTPUT_DIR} ]; then
|
||||
echo -e "${CYAN}Packaging build in '${OUTPUT_DIR}' for `basename "${OUTPUT_DIR}"` to '${PKG_DIR}' with root '${ROOT}'.${NC}"
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
git submodule update --init --recursive
|
||||
|
||||
pushd ../Jellyfin.Versioning
|
||||
./update-version
|
||||
popd
|
||||
|
||||
#TODO enabled proper flag parsing for enabling and disabling building, signing, packaging and publishing
|
||||
|
||||
# Execute all build.sh, package.sh, sign.sh and publish.sh scripts in every folder. In that order. Script should check for artifacts themselves.
|
||||
echo "Running for platforms '$@'."
|
||||
for directory in */ ; do
|
||||
platform=`basename "${directory}"`
|
||||
if [[ $@ == *"$platform"* || $@ = *"all"* ]]; then
|
||||
echo "Processing ${platform}"
|
||||
pushd "$platform"
|
||||
if [ -f build.sh ]; then
|
||||
./build.sh
|
||||
fi
|
||||
if [ -f package.sh ]; then
|
||||
./package.sh
|
||||
fi
|
||||
if [ -f sign.sh ]; then
|
||||
./sign.sh
|
||||
fi
|
||||
if [ -f publish.sh ]; then
|
||||
./publish.sh
|
||||
fi
|
||||
popd
|
||||
else
|
||||
echo "Skipping $platform."
|
||||
fi
|
||||
done
|
||||
Reference in New Issue
Block a user