From 968f715167388afcf426fc5202e6c321579803ed Mon Sep 17 00:00:00 2001 From: P. J. McDermott Date: Sun, 31 May 2015 14:29:40 -0400 Subject: build/release/docs: New script This new script: * Uses git-describe to generate a version string instead of getting the HEAD commit ID from the master branch (which assumed the release was being made from master). * Optionally includes a version string in the archive file name. * Puts documentation files in the release archive under libreboot(_$version)_docs/ instead of libreboot_docs/docs/. --- (limited to 'resources/scripts/helpers/build/release/docs') diff --git a/resources/scripts/helpers/build/release/docs b/resources/scripts/helpers/build/release/docs new file mode 100755 index 0000000..a57f8aa --- /dev/null +++ b/resources/scripts/helpers/build/release/docs @@ -0,0 +1,53 @@ +#!/bin/sh + +# +# helper script: generate the documentation release archive +# +# Copyright (C) 2015 Patrick "P. J." McDermott +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + +[ "x${DEBUG+set}" = 'xset' ] && set -v +set -u -e + +printf 'Building the documentation release archive\n' + +version="$(git describe --tags HEAD)" +if [ "x${VERSION_IN_FILENAMES+set}" = 'xset' ]; then + distdir="libreboot_${version}_docs" +else + distdir='libreboot_docs' +fi + +printf 'Deleting old documentation release archives\n' +rm -f "${distdir}.tar.xz" +rm -f "release/${distdir}.tar.xz" +rm -Rf "${distdir}/" + +printf 'Copying documentation to %s/\n' "${distdir}" +cp -R docs/ "${distdir}/" + +printf '%s\n' "${version}" >"${distdir}/version" + +printf 'Creating %s.tar.xz\n' "${distdir}" +tar -c "${distdir}/" | xz -9e >"${distdir}.tar.xz" + +# Move the archives to the release/ directory. +[ -d release/ ] || mkdir release/ +mv "${distdir}.tar.xz" release/ + +rm -Rf "${distdir}/" + +printf 'Documentation release archives are stored in release/\n' -- cgit v0.9.1