rhodecode-enterprise-ce Files · docs/admin/repo-hooks.rst

rcextensions: new builtin rcextensions....

rcextensions: new builtin rcextensions. - ability to expose output to users from rcextensions - new docs - linking to the code makes the tests always check the integrity of rcextensions - added new hook variables and described them to end users

marcink - - Load All Authors

File last commit:

r1:854a839a default


                r3133:6afdd8e7

default

Download file

             repo-hooks.rst
        
                    56 lines
            
             | 1.4 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / admin / repo-hooks.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        marcink
    
project: added all source files and assets

              r1
            
      .. _repo-hooks:

      |RCE| Repository Hooks

      ======================

      |RCE| installs hooks inside each of the |repos| that it manages. These

      hooks enable users to execute custom actions based on certain events.

      This is the complete list of |repos| hooks and the events which trigger them:

      .. rst-class:: dl-horizontal

          \--CREATE_REPO_HOOK

              Any time a |repo| is created.

          \--CREATE_REPO_GROUP_HOOK

              Any time a |repo| group is created.

          \--CREATE_USER_HOOK

              Any time a user is created.

          \--DELETE_REPO_HOOK

              Any time a |repo| is created.

          \--DELETE_USER_HOOK

              Any time a user is deleted.

          \--PRE_CREATE_USER_HOOK

              Any time a user is created but before the action is executed by |RCE|.

          \--PRE_PULL

              Any pull from a |repo| but before the action is executed by |RCE|.

          \--PRE_PUSH

              Any push to a |repo| but before the action is executed by |RCE|.

          \--POST_PUSH

              After any push to a |repo|.

          \--PUSH_HOOK

              Any push to a |repo|, including editing tags or branches.

              Commits via API actions that update references are also counted.

          \--PULL_HOOK

              Any pull from a Repository.

      Using Repository Hooks

      ----------------------

      To use these hooks you need to install |RCX|. For more information, see the

      :ref:`install-rcx` section.

      Creating Extensions

      -------------------

      To create your own extensions using these hooks, see the :ref:`dev-plug`

      section.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

marcink project: added all source files and assets	r1	.. _repo-hooks:

		\|RCE\| Repository Hooks
		======================

		\|RCE\| installs hooks inside each of the \|repos\| that it manages. These
		hooks enable users to execute custom actions based on certain events.
		This is the complete list of \|repos\| hooks and the events which trigger them:

		.. rst-class:: dl-horizontal

		\--CREATE_REPO_HOOK
		Any time a \|repo\| is created.

		\--CREATE_REPO_GROUP_HOOK
		Any time a \|repo\| group is created.

		\--CREATE_USER_HOOK
		Any time a user is created.

		\--DELETE_REPO_HOOK
		Any time a \|repo\| is created.

		\--DELETE_USER_HOOK
		Any time a user is deleted.

		\--PRE_CREATE_USER_HOOK
		Any time a user is created but before the action is executed by \|RCE\|.

		\--PRE_PULL
		Any pull from a \|repo\| but before the action is executed by \|RCE\|.

		\--PRE_PUSH
		Any push to a \|repo\| but before the action is executed by \|RCE\|.

		\--POST_PUSH
		After any push to a \|repo\|.

		\--PUSH_HOOK
		Any push to a \|repo\|, including editing tags or branches.
		Commits via API actions that update references are also counted.

		\--PULL_HOOK
		Any pull from a Repository.

		Using Repository Hooks
		----------------------

		To use these hooks you need to install \|RCX\|. For more information, see the
		:ref:`install-rcx` section.

		Creating Extensions
		-------------------

		To create your own extensions using these hooks, see the :ref:`dev-plug`
		section.