diff --git a/docs/ahriman.1 b/docs/ahriman.1 index 80acdaee..b58ba2d2 100644 --- a/docs/ahriman.1 +++ b/docs/ahriman.1 @@ -3,7 +3,7 @@ ahriman .SH SYNOPSIS .B ahriman -[-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--report | --no-report] [-q] [--unsafe] [-V] {aur-search,search,help,help-commands-unsafe,help-updates,help-version,version,package-add,add,package-update,package-remove,remove,package-status,status,package-status-remove,package-status-update,status-update,patch-add,patch-list,patch-remove,patch-set-add,repo-backup,repo-check,check,repo-daemon,daemon,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-restore,repo-sign,sign,repo-status-update,repo-sync,sync,repo-tree,repo-triggers,repo-update,update,service-clean,clean,repo-clean,service-config,config,repo-config,service-config-validate,config-validate,repo-config-validate,service-key-import,key-import,service-setup,init,repo-init,repo-setup,setup,service-shell,shell,user-add,user-list,user-remove,web} ... +[-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--report | --no-report] [-q] [--unsafe] [-V] {aur-search,search,help,help-commands-unsafe,help-updates,help-version,version,package-add,add,package-update,package-remove,remove,package-status,status,package-status-remove,package-status-update,status-update,patch-add,patch-list,patch-remove,patch-set-add,repo-backup,repo-check,check,repo-create-keyring,repo-create-mirrorlist,repo-daemon,daemon,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-restore,repo-sign,sign,repo-status-update,repo-sync,sync,repo-tree,repo-triggers,repo-update,update,service-clean,clean,repo-clean,service-config,config,repo-config,service-config-validate,config-validate,repo-config-validate,service-key-import,key-import,service-setup,init,repo-init,repo-setup,setup,service-shell,shell,user-add,user-list,user-remove,web} ... .SH DESCRIPTION ArcH linux ReposItory MANager @@ -91,6 +91,12 @@ backup repository data \fBahriman\fR \fI\,repo\-check\/\fR check for updates .TP +\fBahriman\fR \fI\,repo\-create\-keyring\/\fR +create keyring package +.TP +\fBahriman\fR \fI\,repo\-create\-mirrorlist\/\fR +create mirrorlist package +.TP \fBahriman\fR \fI\,repo\-daemon\/\fR run application as daemon .TP @@ -400,6 +406,16 @@ fetch actual version of VCS packages \fB\-y\fR, \fB\-\-refresh\fR download fresh package databases from the mirror before actions, \-yy to force refresh even if up to date +.SH COMMAND \fI\,'ahriman repo\-create\-keyring'\/\fR +usage: ahriman repo\-create\-keyring [\-h] + +create package which contains list of trusted keys as set by configuration. Note, that this action will only create package, the package itself has to be built manually + +.SH COMMAND \fI\,'ahriman repo\-create\-mirrorlist'\/\fR +usage: ahriman repo\-create\-mirrorlist [\-h] + +create package which contains list of available mirrors as set by configuration. Note, that this action will only create package, the package itself has to be built manually + .SH COMMAND \fI\,'ahriman repo\-daemon'\/\fR usage: ahriman repo\-daemon [\-h] [\-i INTERVAL] [\-\-aur | \-\-no\-aur] [\-\-dependencies | \-\-no\-dependencies] [\-\-local | \-\-no\-local] [\-\-manual | \-\-no\-manual] [\-\-vcs | \-\-no\-vcs] [\-y] diff --git a/docs/ahriman.core.rst b/docs/ahriman.core.rst index 580b2315..f11f1231 100644 --- a/docs/ahriman.core.rst +++ b/docs/ahriman.core.rst @@ -19,6 +19,7 @@ Subpackages ahriman.core.repository ahriman.core.sign ahriman.core.status + ahriman.core.support ahriman.core.triggers ahriman.core.upload diff --git a/docs/ahriman.core.support.pkgbuild.rst b/docs/ahriman.core.support.pkgbuild.rst new file mode 100644 index 00000000..ca8d5d99 --- /dev/null +++ b/docs/ahriman.core.support.pkgbuild.rst @@ -0,0 +1,37 @@ +ahriman.core.support.pkgbuild package +===================================== + +Submodules +---------- + +ahriman.core.support.pkgbuild.keyring\_generator module +------------------------------------------------------- + +.. automodule:: ahriman.core.support.pkgbuild.keyring_generator + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.core.support.pkgbuild.mirrorlist\_generator module +---------------------------------------------------------- + +.. automodule:: ahriman.core.support.pkgbuild.mirrorlist_generator + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.core.support.pkgbuild.pkgbuild\_generator module +-------------------------------------------------------- + +.. automodule:: ahriman.core.support.pkgbuild.pkgbuild_generator + :members: + :no-undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ahriman.core.support.pkgbuild + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/ahriman.core.support.rst b/docs/ahriman.core.support.rst new file mode 100644 index 00000000..ebe39788 --- /dev/null +++ b/docs/ahriman.core.support.rst @@ -0,0 +1,45 @@ +ahriman.core.support package +============================ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + ahriman.core.support.pkgbuild + +Submodules +---------- + +ahriman.core.support.keyring\_trigger module +-------------------------------------------- + +.. automodule:: ahriman.core.support.keyring_trigger + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.core.support.mirrorlist\_trigger module +----------------------------------------------- + +.. automodule:: ahriman.core.support.mirrorlist_trigger + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.core.support.package\_creator module +-------------------------------------------- + +.. automodule:: ahriman.core.support.package_creator + :members: + :no-undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ahriman.core.support + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/completions/bash/_ahriman b/docs/completions/bash/_ahriman index 5b3170bc..efdc8c78 100644 --- a/docs/completions/bash/_ahriman +++ b/docs/completions/bash/_ahriman @@ -1,6 +1,6 @@ # AUTOMATICALLY GENERATED by `shtab` -_shtab_ahriman_subparsers=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' 'package-add' 'add' 'package-update' 'package-remove' 'remove' 'package-status' 'status' 'package-status-remove' 'package-status-update' 'status-update' 'patch-add' 'patch-list' 'patch-remove' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'user-add' 'user-list' 'user-remove' 'web') +_shtab_ahriman_subparsers=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' 'package-add' 'add' 'package-update' 'package-remove' 'remove' 'package-status' 'status' 'package-status-remove' 'package-status-update' 'status-update' 'patch-add' 'patch-list' 'patch-remove' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-create-keyring' 'repo-create-mirrorlist' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'user-add' 'user-list' 'user-remove' 'web') _shtab_ahriman_option_strings=('-h' '--help' '-a' '--architecture' '-c' '--configuration' '--force' '-l' '--lock' '--report' '--no-report' '-q' '--quiet' '--unsafe' '-V' '--version') _shtab_ahriman_aur_search_option_strings=('-h' '--help' '-e' '--exit-code' '--info' '--no-info' '--sort-by') @@ -27,6 +27,8 @@ _shtab_ahriman_patch_set_add_option_strings=('-h' '--help' '-t' '--track') _shtab_ahriman_repo_backup_option_strings=('-h' '--help') _shtab_ahriman_repo_check_option_strings=('-h' '--help' '-e' '--exit-code' '--vcs' '--no-vcs' '-y' '--refresh') _shtab_ahriman_check_option_strings=('-h' '--help' '-e' '--exit-code' '--vcs' '--no-vcs' '-y' '--refresh') +_shtab_ahriman_repo_create_keyring_option_strings=('-h' '--help') +_shtab_ahriman_repo_create_mirrorlist_option_strings=('-h' '--help') _shtab_ahriman_repo_daemon_option_strings=('-h' '--help' '-i' '--interval' '--aur' '--no-aur' '--dependencies' '--no-dependencies' '--local' '--no-local' '--manual' '--no-manual' '--vcs' '--no-vcs' '-y' '--refresh') _shtab_ahriman_daemon_option_strings=('-h' '--help' '-i' '--interval' '--aur' '--no-aur' '--dependencies' '--no-dependencies' '--local' '--no-local' '--manual' '--no-manual' '--vcs' '--no-vcs' '-y' '--refresh') _shtab_ahriman_repo_rebuild_option_strings=('-h' '--help' '--depends-on' '--dry-run' '--from-database' '-e' '--exit-code') @@ -70,7 +72,7 @@ _shtab_ahriman_web_option_strings=('-h' '--help') -_shtab_ahriman_pos_0_choices=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' 'package-add' 'add' 'package-update' 'package-remove' 'remove' 'package-status' 'status' 'package-status-remove' 'package-status-update' 'status-update' 'patch-add' 'patch-list' 'patch-remove' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'user-add' 'user-list' 'user-remove' 'web') +_shtab_ahriman_pos_0_choices=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' 'package-add' 'add' 'package-update' 'package-remove' 'remove' 'package-status' 'status' 'package-status-remove' 'package-status-update' 'status-update' 'patch-add' 'patch-list' 'patch-remove' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-create-keyring' 'repo-create-mirrorlist' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'user-add' 'user-list' 'user-remove' 'web') _shtab_ahriman_aur_search___sort_by_choices=('description' 'first_submitted' 'id' 'last_modified' 'maintainer' 'name' 'num_votes' 'out_of_date' 'package_base' 'package_base_id' 'popularity' 'repository' 'submitter' 'url' 'url_path' 'version') _shtab_ahriman_search___sort_by_choices=('description' 'first_submitted' 'id' 'last_modified' 'maintainer' 'name' 'num_votes' 'out_of_date' 'package_base' 'package_base_id' 'popularity' 'repository' 'submitter' 'url' 'url_path' 'version') _shtab_ahriman_package_add__s_choices=('auto' 'archive' 'aur' 'directory' 'local' 'remote' 'repository') @@ -230,6 +232,10 @@ _shtab_ahriman_check___vcs_nargs=0 _shtab_ahriman_check___no_vcs_nargs=0 _shtab_ahriman_check__y_nargs=0 _shtab_ahriman_check___refresh_nargs=0 +_shtab_ahriman_repo_create_keyring__h_nargs=0 +_shtab_ahriman_repo_create_keyring___help_nargs=0 +_shtab_ahriman_repo_create_mirrorlist__h_nargs=0 +_shtab_ahriman_repo_create_mirrorlist___help_nargs=0 _shtab_ahriman_repo_daemon__h_nargs=0 _shtab_ahriman_repo_daemon___help_nargs=0 _shtab_ahriman_repo_daemon___aur_nargs=0 diff --git a/docs/completions/zsh/_ahriman b/docs/completions/zsh/_ahriman index 5b56362d..f9e4e209 100644 --- a/docs/completions/zsh/_ahriman +++ b/docs/completions/zsh/_ahriman @@ -36,6 +36,8 @@ _shtab_ahriman_commands() { "repo-clean:remove local caches" "repo-config:dump configuration for the specified architecture" "repo-config-validate:validate configuration and print found errors" + "repo-create-keyring:create package which contains list of trusted keys as set by configuration. Note, that this action will only create package, the package itself has to be built manually" + "repo-create-mirrorlist:create package which contains list of available mirrors as set by configuration. Note, that this action will only create package, the package itself has to be built manually" "repo-daemon:start process which periodically will run update process" "repo-init:create initial service configuration, requires root" "repo-rebuild:force rebuild whole repository" @@ -303,6 +305,14 @@ _shtab_ahriman_repo_config_validate_options=( {-e,--exit-code}"[return non-zero exit status if configuration is invalid]" ) +_shtab_ahriman_repo_create_keyring_options=( + "(- : *)"{-h,--help}"[show this help message and exit]" +) + +_shtab_ahriman_repo_create_mirrorlist_options=( + "(- : *)"{-h,--help}"[show this help message and exit]" +) + _shtab_ahriman_repo_daemon_options=( "(- : *)"{-h,--help}"[show this help message and exit]" {-i,--interval}"[interval between runs in seconds]:interval:" @@ -595,6 +605,8 @@ _shtab_ahriman() { repo-clean) _arguments -C $_shtab_ahriman_repo_clean_options ;; repo-config) _arguments -C $_shtab_ahriman_repo_config_options ;; repo-config-validate) _arguments -C $_shtab_ahriman_repo_config_validate_options ;; + repo-create-keyring) _arguments -C $_shtab_ahriman_repo_create_keyring_options ;; + repo-create-mirrorlist) _arguments -C $_shtab_ahriman_repo_create_mirrorlist_options ;; repo-daemon) _arguments -C $_shtab_ahriman_repo_daemon_options ;; repo-init) _arguments -C $_shtab_ahriman_repo_init_options ;; repo-rebuild) _arguments -C $_shtab_ahriman_repo_rebuild_options ;; diff --git a/docs/triggers.rst b/docs/triggers.rst index 8b452106..fb54e453 100644 --- a/docs/triggers.rst +++ b/docs/triggers.rst @@ -31,6 +31,16 @@ This trigger will be called right after build process (``on_result``). It will p Trigger which can be used for reporting. It implements ``on_result`` method and thus being called on each build update and generates report (e.g. html, telegram etc) according to the current settings. +``ahriman.core.support.KeyringTrigger`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Generator for keyring package. This trigger will extract keys from local keychain and pack them into keyring specific format. This trigger will generate sources including PKGBUILD, which can be used later for package building. + +``ahriman.core.support.MirrorlistTrigger`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Simple generator for mirrorlist package, based on the urls which were set by configuration. This trigger will generate sources including PKGBUILD, which can be used later for package building. + ``ahriman.core.upload.UploadTrigger`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^