123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875 |
- #!/bin/bash
- # mkit - simple install helper
- # See LICENSE file for copyright and license details.
-
- init_core() {
- #
- # Load core modules (or die)
- #
- #shellcheck disable=SC1090
- . "$MKIT_DIR/include/mkit.sh" \
- && . "$MKIT_DIR/include/vars.sh" \
- && return 0
- echo "failed to load core; check if MKIT_DIR is set properly: $MKIT_DIR" >&2
- exit 9
- }
-
- #
- # Path to MKit dir (where 'include' is)
- #
- MKIT_DIR=${MKIT_DIR:-$(dirname "$0")}
-
- init_core
-
- mkit_import ini
-
- declare -A MKIT_STUB_LICENSES
- MKIT_STUB_LICENSES[GPLv1]="http://www.gnu.org/licenses/old-licenses/gpl-1.0.md"
- MKIT_STUB_LICENSES[GPLv2]="http://www.gnu.org/licenses/old-licenses/gpl-2.0.md"
- MKIT_STUB_LICENSES[GPLv3]="http://www.gnu.org/licenses/gpl-3.0.md"
- MKIT_STUB_LICENSES[LGPLv2]="http://www.gnu.org/licenses/old-licenses/lgpl-2.1.md"
- MKIT_STUB_LICENSES[LGPLv3]="http://www.gnu.org/licenses/lgpl-3.0.md"
- MKIT_STUB_LICENSES[AGPLv3]="http://www.gnu.org/licenses/agpl-3.0.md"
- MKIT_STUB_LICENSES[FDLv1.3]="http://www.gnu.org/licenses/fdl-1.3.md"
- MKIT_STUB_LICENSES[FDLv1.2]="http://www.gnu.org/licenses/old-licenses/fdl-1.2.md"
- MKIT_STUB_LICENSES[FDLv1.1]="http://www.gnu.org/licenses/old-licenses/fdl-1.1.md"
-
-
- deploy() {
- local file=$1 # which known file?
- local any_name=${NiceName:-$PackageName}
- local tmp
- tmp=$(mktemp -t mkit.stub.deploy.XXXXXXX)
- mkdir -p "$(dirname "$file")"
- case $file in
-
- Makefile)
- echo -n "# $any_name"
- test -n "$Tagline" && echo -n " - $Tagline"
- echo
- $MkLicense && echo '# See LICENSE.md file for copyright and license details.'
- echo ''
- echo 'MKIT_DIR=utils/mkit'
- #shellcheck disable=SC2016
- echo 'include $(MKIT_DIR)/mkit.mk'
- ;;
-
- README.md)
- echo "$any_name"
- tr -c '=\n' '=' <<<"$any_name"
- echo ''
- if test -n "$Tagline"; then
- echo "$Tagline"
- else
- echo "(Nothing to say about this project.)"
- fi
- echo ""
- echo "See MAINTAINERS.md for instructions how to build and"
- echo "maintain this MKit project."
- ;;
-
- MAINTAINERS.md)
- local heading="$any_name - maintainer instructions"
- echo "${heading^^}"
- tr -c '=\n' '=' <<<"$heading"
- echo ''
- echo "<!--"
- echo " Note: This file has been auto-generated by MKit"
- echo " v$MKIT_VERSION when initializing the project."
- echo "-->"
- echo ''
- echo "This project is using MKit for packaging and versioning"
- echo "meta-data; this file describes how to do basic maintenance"
- echo "operations."
- echo ''
- echo "MKit uses GNU Make as an interface, so all operations are"
- echo "'make' targets and GNU Make takes care of the dependencies"
- echo "between them. For example, to install the project it's enough"
- echo "to call 'make install'; GNU Make will call 'make built'"
- echo "automatically if needed."
- echo ""
- echo ""
- echo "Variables"
- echo "---------"
- echo ""
- echo " * \`DESTDIR\` - root of the installation destination"
- echo " * \`PREFIX\` - deployment prefix (often \`/usr\` or"
- echo " \`/usr/local\`)"
- echo " * \`MKIT_DRY\` - set to \`true\` to prevent MKit from making"
- echo " any changes"
- echo " * \`MKIT_DEBUG\` - set to \`true\` to have MKit display"
- echo " (lots of) debugging information"
- echo ""
- echo "See *utils/mkit/include/vars.sh* for full list oof supported"
- echo "variables. (You can use \`sfdoc utils/mkit/include/vars.sh\`"
- echo "if you have sfdoc installed.)"
- echo ""
- echo ""
- echo "Building and installation"
- echo "-------------------------"
- echo ""
- echo "These operations are allowed on any branch. Assets built from"
- echo "development branches will be marked using distinctive version"
- echo "number containing timestamp, branch name and commit short-hash."
- echo ""
- echo " * \`make\` - same as \`make build\`"
- echo " * \`make build\` - build project files"
- echo " * \`make install\` - install project to \`\$DESTDIR\`"
- echo " * \`make uninstall\` - uninstall project from \`\$DESTDIR\`"
- echo " * \`make rpmstuff\` - create RPM SPEC file and a source"
- echo " tarball"
- echo " * \`make debstuff\` - create 'debian' directory and a source"
- echo " tarball"
- echo " * \`make clean\` - remove any previously built assets".
- echo ""
- echo ""
- echo "Versioning"
- echo "----------"
- echo ""
- echo "These operations are only allowed on *release source branch*:"
- echo ""
- echo " * \`make vbump\` - bump version and create bump commit"
- echo " * \`make release\` - create release tag"
- echo ""
- echo ""
- echo "Recommended workflow"
- echo "--------------------"
- echo ""
- echo ""
- echo "### Development and testing ###"
- echo ""
- echo "Any branch can be used to create any kind of asset. Assets"
- echo "built from development branch will be marked using distinctive"
- echo "version number in all MKit macros."
- echo ""
- echo "Development is done in branches as needed, but one branch"
- echo "(often called *master*, *main* or *trunk*) is designated as"
- echo "**release source** branch. Only maintainer can push into this"
- echo "branch and this is where maintainer creates the next release."
- echo ""
- echo ""
- echo "### Versioning and releases ###"
- echo ""
- echo "After all development branches are merged and project is"
- echo "considered ready for release, maintainer will create new"
- echo "release. This consists of three steps (only two of them are"
- echo "assisted by MKit):"
- echo ""
- echo " 1. \`make vbump\` - will auto-edit [project:version] in"
- echo " mkit.ini and start creating **bump commit**."
- echo ""
- echo " **Bump commit** is a special commit which consists of:"
- echo ""
- echo " * Bump of version in mkit.ini"
- echo " * commit message providing rudimentary human"
- echo " readable summary of changes."
- echo ""
- echo " \`make vbump\` target will cause bump of the *last*"
- echo " version fragment (Z, or PATCH in SemVer). To bump other"
- echo " fragments, use \`make vbump_y\` or \`make vbump_x\` (MINOR"
- echo " or MAJOR in SemVer, respectively)."
- echo ""
- echo " MKit will create a template of the message by scanning"
- echo " all commits since last release and invoke 'git commit' so"
- echo " that maintainer is presented with a window editing the"
- echo " commit message."
- echo ""
- echo " Maintainer is responsible for finishing the commit message"
- echo " by:"
- echo ""
- echo " * Re-wording and merging the items as needed."
- echo " * Adding any details, if needed."
- echo " * Removing short hashes and file lists added by MKit"
- echo " (these are added only to make editing easier)."
- echo ""
- echo " Once maintainer is happy with *bump commit* message,"
- echo " they can exit the editor and move on to next step."
- echo ""
- echo " 2. \`make release\` - will check if latest commit on current"
- echo " branch is a *bump commit*, and if yes, will create"
- echo " a corresponding **release tag**."
- echo ""
- echo " **Release tags** are annotated tags (see *git-tag(1)*)"
- echo " formed by version number prefixed by letter \`v\` and are"
- echo " used by MKit to calculate version number when building"
- echo " assets. Release tags contain the *bump commit* message"
- echo " as the annotation."
- echo ""
- echo " If a *release destination* branch is specified as"
- echo " [project:reldst] in mkit.ini, MKit will also update that"
- echo " branch so that it points to the same commmit as the"
- echo " newly created release tag."
- echo ""
- echo " 3. Maintainer will push branches and commits to any shared"
- echo " remotes as needed."
- echo ""
- echo " Warning: This is your last chance to fix any mistakes."
- echo " git tags are designed to be permanent, \"official\","
- echo " write-only objects and they will typically quickly spread"
- echo " to other clones. *Don't count on getting rid of release"
- echo " tag*."
- echo ""
-
- ;;
-
- */mkit.ini|mkit.ini)
- echo "[project]"
- {
- echo "version = $Version"
- test -n "$Codename" && echo "codename = $Codename"
- test -n "$NiceName" && echo "name = $NiceName"
- test -n "$Tagline" && echo "tagline = $Tagline"
- test -n "$PackageName" && echo "pkgname = $PackageName"
- test -n "$Maintainer" && echo "maintainer = $Maintainer"
- test -n "$VcsBrowser" && echo "vcs_browser = $VcsBrowser"
- test -n "$RelSrc" && echo "relsrc = $RelSrc"
- test -n "$RelDst" && echo "reldst = $RelDst"
- } | reformat_section
- if updating; then
- remake_section dist
- remake_section ENV
- remake_section roots
- remake_section macros
- remake_section modes
- remake_section files
- else
- echo ""
- echo "[dist]"
- {
- $MkLicense && echo "tarball = LICENSE.md"
- $MkReadme && echo "tarball = MAINTAINERS.md"
- $MkMakefile && echo "tarball = Makefile"
- $MkReadme && echo "tarball = README.md"
- echo "tarball = mkit.ini"
- $MkPackaging && echo "tarball = packaging"
- echo "tarball = src"
- echo "tarball = tests"
- echo "tarball = utils"
- $MkPackaging && echo "rpmstuff = packaging/template.spec"
- $MkPackaging && echo "debstuff = packaging/debian"
- } | reformat_section
- echo ""
- echo "[ENV]"
- {
- echo " PREFIX = /usr/local"
- } | reformat_section
- echo ""
- echo "[roots]"
- {
- echo "bin = [ENV:PREFIX]/bin"
- echo "doc = [ENV:PREFIX]/share/doc/$PackageName"
- } | reformat_section
- echo ""
- echo "[macros]"
- {
- echo "__${PackageName^^}_FOO__ = Barr.."
- echo " __PROJECT_DESC_MAIN__ = MKIT_STUB_DESCRIPTION - replace this with your project"
- echo " __PROJECT_DESC_MAIN__ = MKIT_STUB_DESCRIPTION .. description; this will appear"
- echo " __PROJECT_DESC_MAIN__ = MKIT_STUB_DESCRIPTION .. in places like rpm -i"
- } | reformat_section
- echo ""
- echo "[modes]"
- {
- echo "bin = 755"
- echo "doc = 644"
- } | reformat_section
- echo ""
- echo "[files]"
- {
- echo "bin = src/$PackageName"
- $MkLicense && echo "doc = LICENSE.md"
- $MkReadme && echo "doc = README.md"
- } | reformat_section
- fi
- echo ""
- echo "#mkit version=$MKIT_VERSION"
- ;;
-
- packaging/template.spec)
- echo 'Name: __MKIT_PROJ_PKGNAME__'
- echo 'Version: __MKIT_PROJ_VERSION__'
- echo 'Release: 1%{?dist}'
- echo 'Summary: __MKIT_PROJ_NAME__ - __MKIT_PROJ_TAGLINE__'
- test -n "$VcsBrowser" && echo 'URL: __MKIT_PROJ_VCS_BROWSER__'
- $MkLicense && echo "License: $License"
- echo 'Source0: %{name}-%{version}.tar.gz'
- echo 'BuildArch: noarch'
- echo 'BuildRequires: make'
- echo ''
- echo 'Requires: MKIT_STUB_REQUIRES'
- echo '%description'
- echo '__PROJECT_DESC_MAIN__'
- echo ''
- echo '%prep'
- echo '%setup -q'
- echo ''
- echo '%build'
- echo 'make %{?_smp_mflags} PREFIX=/usr'
- echo ''
- echo '%install'
- echo '%make_install PREFIX=/usr'
- echo ''
- echo '%files'
- echo 'MKIT_STUB_FILELIST'
- echo ''
- echo '%changelog'
- echo ''
- echo '# specfile built with MKit __MKIT_MKIT_VERSION__'
- echo "# .. based on stub from: $MKIT_VERSION"
- ;;
-
- packaging/debian/copyright)
- echo ""
- ;;
-
- packaging/debian/control)
- echo 'Source: __MKIT_PROJ_PKGNAME__'
- echo 'Maintainer: __MKIT_PROJ_MAINTAINER__'
- test -n "$VcsBrowser" && echo 'Vcs-Browser: __MKIT_PROJ_VCS_BROWSER__'
- echo 'Section: misc'
- echo 'Priority: extra'
- echo 'Standards-Version: 3.9.2'
- echo 'Build-Depends:'
- echo ' debhelper (>= 9),'
- echo ' make,'
- echo ''
- echo 'Package: __MKIT_PROJ_PKGNAME__'
- echo 'Architecture: all'
- echo 'Depends: MKIT_STUB_REQUIRES'
- echo 'Description: __MKIT_PROJ_NAME__ - __MKIT_PROJ_TAGLINE__'
- echo ' __PROJECT_DESC_MAIN__'
- echo ''
- echo '# control file built with MKit __MKIT_MKIT_VERSION__'
- echo "# .. based on stub from: $MKIT_VERSION"
- ;;
-
- packaging/debian/changelog)
- echo '__MKIT_PROJ_PKGNAME__ (__MKIT_PROJ_VERSION__-1) UNRELEASED; urgency=medium'
- echo ''
- echo ' * Initial release. (Closes: #XXXXXX)'
- echo ''
- echo " -- __MKIT_PROJ_MAINTAINER__ $(date -R)"
- ;;
-
- packaging/debian/compat)
- echo 9
- ;;
-
- packaging/debian/rules)
- echo '#!/usr/bin/make -f'
- echo ''
- echo '%:'
- echo ''
- echo ' PREFIX=/usr dh $@'
- echo ''
- echo 'override_dh_auto_install:'
- echo ''
- echo ' make install DESTDIR=debian/tmp'
- ;;
-
- packaging/debian/source/format)
- echo '3.0 (quilt)'
- ;;
-
- packaging/debian/install)
- echo MKIT_STUB_FILELIST
- ;;
-
- src/*.skel)
- echo 'echo "my version is: __MKIT_PROJ_VERSION__"'
- echo 'echo "And that'"'"'s all, folks!"'
- ;;
-
- LICENSE.md)
- local url # license URL
- url="${MKIT_STUB_LICENSES[$License]}"
- curl -sf "$url" \
- || die "failed to download license: $url"
- ;;
-
- .mkit/autoclean)
- ;;
-
- MKIT_STUB_README.md)
- echo "FINISHING MKIT CONFIGURATION"
- echo "============================"
- echo ""
- echo "Congratulations, your new project has been configured!"
- echo ""
- echo "However, the *stub* script is not able to figure out"
- echo "everything, so few things still need to be done manually."
- echo "This document will guide you throught the rest of the"
- echo "process."
- echo ""
- echo ""
- echo "Structure"
- echo "---------"
- echo ""
- echo "First, let's go through the directory structure:"
- echo ""
- echo " * *src* directory - here is your main place to store"
- echo " source files. This includes also documents like user"
- echo " manuals---IOW, anything intended to end up on user's"
- echo " machine should be uder 'src'."
- echo ""
- echo " Note that during build time, files named ending with"
- echo " '.skel' are subject to macro expansion, see mkit.ini"
- echo " section below for details."
- echo ""
- echo " * *notes* directory - here you shall store notes"
- echo " intended for people contributing to your project,"
- echo " for instance, guidelines, coding style documents,"
- echo " TODOs, ideas, plans..."
- echo ""
- echo " * *utils* directory - here you shall store utilities"
- echo " and scripts that will help you with project maintenance,"
- echo " and that, unlike software like compilers or versioning"
- echo " systems, can (and should) be embedded inside the"
- echo " repository."
- echo ""
- echo " MKit itself is one nice example. :)"
-
- if $MkPackaging; then
- echo ""
- echo " * *packaging* directory contains templates that enable"
- echo " MKit create raw stuffs used to create DEB or RPM"
- echo " packages. Similar to '.skel' files in 'src', all files"
- echo " here are automatically considered for macro expansion,"
- echo " no matter how they are named (see mkit.ini section"
- echo " below)."
- echo ""
- echo " NOTE: these templates, as well as any packages created by"
- echo " them are intended only for experimental, private use and"
- echo " testing."
- echo ""
- echo " Should you have ambition to create 'real' packages for"
- echo " OS distribution such as Debian or Fedora (what a great"
- echo " idea!), be prepared that you will need to follow their"
- echo " guidelines. This will most probably mean huge changes"
- echo " to these packages or even changes to your workflow."
- echo ""
- echo ""
- echo "Placeholders"
- echo "------------"
- echo ""
- echo "At places where *stub* script did not have way to get all"
- echo "information automatically, it has inserted placeholders."
- echo "You will need to go through all of these placeholders and"
- echo "replace them with proper data."
- echo ""
- echo "Please follow instructions:"
- echo ""
- echo " 1. Look for placeholders starting with \`MKIT_STUB_\`"
- echo " prefix by calling this command:"
- echo ""
- echo " grep -l MKIT_STUB_ -r"
- echo ""
- echo " 2. Go through each file and locate the placeholder. (You"
- echo " will also see placeholders like \`__MKIT_*__\`, you can"
- echo " ignore those."
- echo ""
- echo " 3. Replace placeholder with appropriate information:"
- echo ""
- echo " * \`MKIT_STUB_REQUIRES\` - Requirements of your"
- echo " project."
- echo ""
- echo " * \`MKIT_STUB_DESCRIPTION\` - Description of your"
- echo " project (few sentences to paragraphs)."
- echo ""
- echo " * \`MKIT_STUB_FILELIST\` - List of full paths to"
- echo " your files after installation."
- echo ""
- echo " Note that in case of debian/install files, PREFIX"
- echo " based paths (eg. /usr/bin) in this file should be as"
- echo " if PREFIX was /usr."
- echo ""
- echo " In case of Fedora-based distro, you should make use"
- echo " of RPM macros:"
- echo ""
- echo " https://fedoraproject.org/wiki/Packaging:RPMMacros"
- echo ""
- echo " Refer to these documents for further details:"
- echo ""
- echo " http://rpm-guide.readthedocs.io/"
- echo " https://www.debian.org/doc/manuals/maint-guide/"
- fi
-
- echo ""
- echo ""
- echo "mkit.ini"
- echo "--------"
- echo ""
- echo "Most sections still need to be reviewed. In order to do"
- echo "that, you will need to understand how MKit works:"
- echo ""
- echo " 1. First, you need to define *roles* your files will play"
- echo " when they are installed on user's file systems. These"
- echo " roles then imply where and how the files should be"
- echo " deployed."
- echo ""
- echo " Typical example of a role is e.g. 'bin' for commands"
- echo " (normally under '/usr/bin' or '/usr/local/bin'), 'doc'"
- echo " for documents or 'lib' for libraries."
- echo ""
- echo " 2. Next, in \`[roots]\` section, you have to set target"
- echo " root directory for each role. However, in order to"
- echo " enable people to implement local conventions, it is"
- echo " considered a good manner to also respect PREFIX"
- echo " environment variable. For this reason, most paths"
- echo " need to start with \`[ENV:PREFIX]\`."
- echo ""
- echo " 3. \`[files]\` section is where you assign actual files"
- echo " from your repository to their final paths. The format"
- echo " is \`ROLE = REPOPATH [RENAMED]\`, where ROLE is file's"
- echo " role, REPOPATH is relative path to the file."
- echo ""
- echo " Final path is then composed by taking path assigned to"
- echo " ROLE and appending file's name. However, if you need"
- echo " the deployed file to have different name than in the"
- echo " codebase, you can specify the other name as RENAMED."
- echo ""
- echo " Note that you don't need to address every single file"
- echo " individually, if in your repo you have a directory with"
- echo " 100 files of the same role, you can add just path to the"
- echo " directory itself."
- echo ""
- echo " 4. If some roles require special permissions on your files,"
- echo " \`[modes]\` section is your friend. Permissions here"
- echo " should be in UNIX octal format."
- echo ""
- echo " 5. Next, \`[macros]\` section allows you to define own"
- echo " placeholders that will be replaced when your scripts are"
- echo " built. Each file in 'src' directory that is named with"
- echo " '.skel' suffix, and each file from 'packaging' directory"
- echo " (no matter its name), can contain one or more of macros"
- echo " defined here, plus range of macros automatically defined"
- echo " by MKit. During build, these macros are replaced with"
- echo " their actual values."
- echo ""
- echo " 6. Less interesting, but important section is \`[dist]\`,"
- echo " which lists files in your codebase that will be added"
- echo " to distribution tarball (part of \"stuffs\" mentioned"
- echo " above). Listing directory here will include all its"
- echo " contents, and normally it's OK to be very inclusive, so"
- echo " most of the time this section should be OK."
- echo ""
- echo " 7. Even less interesting is section \`[ENV]\`. It is"
- echo " special in that it provides *default* value for an"
- echo " environment variable. You almost never need to touch"
- echo " this."
- echo ""
- echo " 8. Finally, the most interesting section! \`[project]\`,"
- echo " provides most general information for your project such"
- echo " as name and version."
- echo ""
- echo " Note that the \`version\` key is another \"special"
- echo " snowflake\" -- it is now set to 0.0.0, and you **should"
- echo " not need** to change it manually. When you feel you"
- echo " a are ready to release next version of your evolving"
- echo " project, simply call \`make vbump\` and MKit will take"
- echo " care of everything!"
-
- if $MkMakefile; then
- echo ""
- echo ""
- echo "Makefile"
- echo "--------"
- echo ""
- echo "*stub* script also created a Makefile for you, but all"
- echo "it really does is include MKit's own mkit.mk, which in turn"
- echo "only maps \`make\` targets to actual mkit script calls."
- echo "Unless your project already uses GNU Make, you should not"
- echo "need to change this file."
- fi
-
- if $MkReadme; then
- echo ""
- echo ""
- echo "README.md and MAINTAINERS.md"
- echo "----------------------------"
- echo ""
- echo "Each serious project needs a serious README. Which is why"
- echo "*stub* has created a 'stub' of one for you."
- echo ""
- echo "Furthermore MAINTAINERS.md is created to help maintainers"
- echo "do basic MKit operations such as building assets and making"
- echo "releases."
- fi
-
- echo ""
- echo ""
- echo "The final touch"
- echo "---------------"
- echo ""
- echo "Once you have reviewed everything, just delete this file!"
- ;;
-
- esac >"$tmp"
- cat "$tmp" > "$file"
- rm "$tmp"
- }
-
- known_licenses() {
- local key
- local first=true
- for key in "${!MKIT_STUB_LICENSES[@]}"; do
- $first && echo "$key" && continue
- echo ", $key"
- done
- }
-
- usage() {
- {
- echo "Usage:"
- echo " stub [options] new PKGNAME"
- echo " stub [options] update"
- echo " stub -L"
- echo ""
- echo "Options:"
- echo ""
- echo " -c CODENAME your project codename"
- echo " -t TAGLINE your project tagline"
- echo " -b RELSRC pre-release branch"
- echo " -B RELDST post-release branch"
- echo " -n NICENAME your project's 'nice' name"
- echo " -l LICENSE your options's license (see -L)"
- echo " -m MAINT project maintainer's name and e-mail"
- echo " -v URL URL to public code browser"
- echo " -V VERSION initial version (default: 0.0.0)"
- echo " -a enable autoclean ('make clean' after"
- echo " each 'make install')"
- echo " -g make git commits before and after"
- echo " (implies -y)"
- echo " -y don't ask, just do it"
- echo " -R skip creating README.md"
- echo " -M skip creating Makefile"
- echo " -P skip creating packaging templates"
- echo " -L list known licenses and exit"
- echo ""
- echo "PKGNAME should be packaging-friendly name, ie. consist"
- echo "only of small letters, numbers, underscore and dash."
- echo "For your 'real' name, use NICENAME, which can be any"
- echo "string."
- } >&2
- exit 2
- }
-
- confirm() {
- local response # user's response to our warning
- $Force && return 0
- {
- echo "Warning: This operation can be destructive for your"
- echo "current codebase. At least following files will be"
- echo "created or overwritten:"
- echo ""
- $MkPackaging && echo " * 'packaging' directory (pass -P to avoid)"
- $MkMakefile && echo " * 'Makefile' (pass -M to avoid)"
- $MkReadme && echo " * 'README.md' (pass -R to avoid)"
- $MkLicense && echo " * 'LICENSE.md' (omit -l to avoid)"
- echo " * 'mkit.ini'"
- echo ""
- read -p "Type 'yes' to proceed: " -r response
- } >&2
- test "$response" == "yes" && return 0
- warn "Aborting."
- return 1
- }
-
- mkcommit_backup() {
- git ls-files --others \
- | grep -qv -e '^utils/mkit$' -e '^utils/mkit/' \
- || { warn "nothing to back up"; return 0; }
- git add . || return
- git rm -r --cached utils/mkit || return
- git commit -m "WIP [mkit/stub] backup" || return
- }
-
- mkcommit_mkit_code() {
- git ls-files --others \
- | grep -q -e '^utils/mkit$' -e '^utils/mkit/' \
- || return 0
- git add utils/mkit || return
- git commit -m "WIP [mkit/stub] Add MKit version v$MKIT_VERSION" || return
- }
-
- mkcommit_mkit_conf() {
- local msg # commit message (the important art
- git add . || return
- case $Action in
- new) msg="Add MKit configuration stub" ;;
- update) msg="Update MKit configuration" ;;
- esac
- git commit -m "WIP [mkit/stub] $msg" || return
- }
-
- deploy_packaging() {
- rm -rf packaging
- deploy packaging/template.spec
- deploy packaging/debian/copyright
- deploy packaging/debian/control
- deploy packaging/debian/changelog
- deploy packaging/debian/compat
- deploy packaging/debian/install
- deploy packaging/debian/rules
- deploy packaging/debian/source/format
- }
-
- init_from_existing() {
- #
- # Initialize variables from old mkit.ini
- #
- test -f "$MKIT_INI" \
- || die "mkit.ini not found; aborting update: $MKIT_INI"
- user_gave Codename || Codename=$(ini_raw1v project:codename)
- user_gave License || License=$(ini_raw1v project:license)
- user_gave Maintainer || Maintainer=$(ini_raw1v project:maintainer)
- user_gave NiceName || NiceName=$(ini_raw1v project:name)
- user_gave PackageName || PackageName=$(ini_raw1v project:pkgname)
- user_gave RelDst || RelDst=$(ini_raw1v project:reldst)
- user_gave RelSrc || RelSrc=$(ini_raw1v project:relsrc)
- user_gave Tagline || Tagline=$(ini_raw1v project:tagline)
- user_gave VcsBrowser || VcsBrowser=$(ini_raw1v project:vcs_browser)
- user_gave Version || Version=$(ini_raw1v project:version)
- }
-
- ini_raw1v() {
- #
- # Read raw scalar from mkit.ini
- #
- local path=$1
- MKIT_INI_EXPAND=0 ini 1value "$path"
- }
-
- user_gave() {
- #
- # True if user gave value to variable $1
- #
- local var=$1 # name of the variable
- { test "${UserGave[$var]}" == 1; } 2>/dev/null
- }
-
- updating() {
- #
- # Are we updating?
- #
- test "$Action" == update
- }
-
- remake_section() {
- #
- # Re-compose mkit.ini section $1
- #
- local section=$1
- local key
- local value
- ini lskeys "$section" | grep -q . \
- || return 1
- echo ""
- echo "[$section]"
- ini lskeys "$section" \
- | while read -r key; do
- MKIT_INI_EXPAND=0 ini values "$section:$key" \
- | while read -r value; do
- echo "$key = $value"
- done
- done \
- | reformat_section
- }
-
- reformat_section() {
- #
- # Re-format "k = v" on stdin as "nice" ini section
- #
- local key
- local eq
- local value
- while read -r key eq value; do
- test "$eq" == "=" || {
- warn "ignoring malformed ini line: $key $eq $value"
- continue
- }
- echo "$key = $value"
- done \
- | sed 's/ *= */=/; s/^ *//; s/ *$//' \
- | column -t -s= -o' = ' \
- | sed 's/^/ /'
- }
-
- main() {
- local NiceName # human-readable project name
- local PackageName # machine-safe project (package) name
- local RelSrc # pre-release branch
- local RelDst # post-release branch
- local Codename # release codename
- local Tagline # project tagline
- local Maintainer # project maintainer (Name + e-mail)
- local VcsBrowser # VCS browser (eg. GitHub URL)
- local Version=0.0.0 # project version
- local AutoClean=false # touch .mkit/autoclean?
- local MkCommits=false # create pre/post git commits?
- local Force=false # go without asking?
- local MkReadme=true # create README.md?
- local MkMakefile=true # create Makefile?
- local MkPackaging=true # create packaging templates?
- local MkLicense=false # create LICENSE.md file
- local Action # 'update' to respect existing, 'new' to force
- # rewrite incl. MKIT_STUB_* placeholders
- declare -A UserGave
- while true; do case $1 in
- -n) NiceName=$2; UserGave[NiceName]=1; shift 2 || usage ;;
- -b) RelSrc=$2; UserGave[RelSrc]=1; shift 2 || usage ;;
- -B) RelDst=$2; UserGave[RelDst]=1; shift 2 || usage ;;
- -c) Codename=$2; UserGave[Codename]=1; shift 2 || usage ;;
- -t) Tagline=$2; UserGave[Tagline]=1; shift 2 || usage ;;
- -l) License=$2; UserGave[License]=1; shift 2 || usage ;;
- -m) Maintainer=$2; UserGave[Maintainer]=1; shift 2 || usage ;;
- -v) VcsBrowser=$2; UserGave[VcsBrowser]=1; shift 2 || usage ;;
- -V) Version=$2; UserGave[Version]=1; shift 2 || usage ;;
- -M) MkMakefile=false; shift ;;
- -R) MkReadme=false; shift ;;
- -a) AutoClean=true; shift ;;
- -y) Force=true; shift ;;
- -g) MkCommits=true; shift ;;
- -P) MkPackaging=false; shift ;;
- -L) known_licenses | tr , '\n'; exit 0 ;;
- -*) usage ;;
- *) break ;;
- esac done
- Action=$1; PackageName=$2
- case $Action:$PackageName in
- new:) usage ;;
- new:*) : ;;
- update:) : ;;
- update:*) usage ;;
- *) usage ;;
- esac
- updating && init_from_existing
- if test -n "$License"; then
- known_licenses | grep -qxFe "$License" \
- || die "unknown license (use -L to get list): $License"
- MkLicense=true
- fi
- if $MkCommits; then
- mkcommit_backup || die "failed creating backup commit"
- Force=true
- fi
- confirm || return 1
- deploy "$MKIT_INI"
- deploy src/"$PackageName".skel
- $MkMakefile && deploy Makefile
- $MkReadme && deploy README.md
- $MkReadme && deploy MAINTAINERS.md
- $MkLicense && deploy LICENSE.md
- $AutoClean && deploy .mkit/autoclean
- $MkPackaging && deploy_packaging
- if $MkCommits; then
- mkcommit_mkit_code || die "failed creating post-commit"
- mkcommit_mkit_conf || die "failed creating post-commit"
- fi
- deploy MKIT_STUB_README.md
- warn "Configuration stub built, follow instructions in"
- warn "MKIT_STUB_README.md to finish configuration."
- return 0
- }
-
- main "$@"
|