diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..39071ed --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +MIT License + +Copyright (c) 2019- Knut Ahlers + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..1e40de1 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Luzifer / archrepo + +This repository contains the setup and tools to maintain my "private" Archlinux repository with AUR packages and packages I rely on which does not have a place in AUR. This setup is intended for my own use and uses a clean build environment for each package. + +> **Warning:** As I'm not a [Trusted User](https://wiki.archlinux.org/index.php/Trusted_Users) and this is not an official Archlinux repository you probably don't want to use this repository directly - at last you don't know whether those packages were tempered with. If you do please keep it civilized: if you plan to use the repository in build causing high amounts of traffic or many machines please don't or at least create a mirror. + +## Setup + +This repository contains four essential parts: + +- The `scripts` folder containing bash scripts to control all actions +- The `Makefile` to orchestrate everything. The main functionality is the `maintenance` target (or just `make`) +- The package lists (`aur-packages` and `repo-urls`) +- The `luzifer.asc` public key + +It currently relies on my [`luzifer/arch-repo-builder`](https://github.com/luzifer-docker/arch-repo-builder) docker image which does all of the building within a clean environment for each package and on [`repoctl`](https://github.com/cassava/repoctl) for some cleanup tasks (which is subject to change as I want the setup to be as self-contained as possible). + +For the initial setup you need to do some steps: + +- Adjust the `Makefile` as you need different `download` and `upload` targets +- Create an empty database `tar -cJf luzifer.db.tar.xz -T /dev/null` (adjust the filename) +- Put the public key for your repo into `luzifer.asc` (filename should match the database, makes it easier to find) +- Set up your `aur-packages` and `repo-urls` package lists + - `aur-packages` contains just names of AUR packages (no comments or other stuff!) + - `repo-urls` contains one git repository URL per line (comments allowed) +- Provide a docker daemon and all tools listed in the `check_tools` target of the `Makefile` + +Afterwards you should be good to just `make` your first build. Depending on the number of packages you selected to be in your repo you might go and fetch dinner while it builds. + +## Maintenance + +The repo should be updated on a regular base by just executing `make` on it. This will check for updates of the AUR packages specified in the `aur-packages` list and update them if their version is newer than the local one. Also it will check for new commits in the repos listed in `repo-urls` and build them if there are newer commits than those in the local cache. + +## Flaws / Remarks / TODOs + +- The whole build already strongly relies on Archlinux tools so will not run on any other distro +- Currently `repoctl` as an external tool is used to clean up old packages and the package database. This shall be done by local scripts in the future. +- For `aur-packages` having dynamic `pkgver` calculation the update check will not work properly until the `PKGBUILD` in AUR is updated (those packages can be built manually using `bash ./scripts/update-aur.sh && make do_cleanup upload` +- For `repo-urls` the same applies: for example my `vim-go-tools` package relies on periodic re-builds which are not executed as commits are quite rare. For those packages at the moment a call to `bash ./scripts/update-repo.sh && make do_cleanup upload` is required