diff --git a/README.md b/README.md index d48620a..e7c3ea0 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,27 @@ BuffyBox is a suite of graphical applications for the terminal. You can join our development chat at [#buffybox:matrix.org]. +## Making a release + +To make it easier for distributions to package BuffyBox, we include source tarballs including the LVGL submodule in GitLab releases. See [unl0kr#42] for more background on this. + +Producing and uploading a source tarball requires [git-archive-all] to be installed as well as an access token for the GitLab API. To tag a release and upload a source tarball, run + +``` +./release.sh $VERSION $TOKEN +``` + +Once the upload completes, create a new release on GitLab and attach the URL of the uploaded source tarball. + ## License This project is licensed under 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. [#buffybox:matrix.org]: https://matrix.to/#/#buffybox:matrix.org [buffyboard]: ./buffyboard +[git-archive-all]: https://github.com/Kentzo/git-archive-all [LVGL]: https://github.com/lvgl/lvgl [squeek2lvgl]: ./squeek2lvgl [Squeekboard]: https://gitlab.gnome.org/World/Phosh/squeekboard [unl0kr]: ./unl0kr +[unl0kr#42]: https://gitlab.com/cherrypicker/unl0kr/-/issues/42 diff --git a/unl0kr/archive.sh b/archive.sh similarity index 81% rename from unl0kr/archive.sh rename to archive.sh index da82dbf..e4f6768 100755 --- a/unl0kr/archive.sh +++ b/archive.sh @@ -1,7 +1,7 @@ #!/bin/bash version=$(git describe --exact-match --tags HEAD || git rev-parse HEAD) -archive=unl0kr-${version}.tar.gz +archive=buffybox-${version}.tar.gz echo "Archiving repository with submodules..." git-archive-all ${archive} @@ -10,7 +10,7 @@ echo "Uploading archive to GitLab..." response=$(curl --request POST \ --header "PRIVATE-TOKEN: $1" \ --form "file=@${archive}" \ - "https://gitlab.com/api/v4/projects/29322771/uploads") + "https://gitlab.com/api/v4/projects/52322952/uploads") path=$(echo "${response}" | jq -r .full_path) diff --git a/unl0kr/release.sh b/release.sh similarity index 81% rename from unl0kr/release.sh rename to release.sh index 311abdf..a594aa9 100755 --- a/unl0kr/release.sh +++ b/release.sh @@ -25,4 +25,4 @@ git push --tags ./archive.sh "$2" -echo "Now create a release for https://gitlab.com/cherrypicker/unl0kr/-/tags/$1 and attach the uploaded archive" \ No newline at end of file +echo "Now create a release for https://gitlab.com/postmarketOS/buffybox/-/tags/$1 and attach the uploaded archive" \ No newline at end of file