mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-07-09 12:30:15 +02:00
54 lines
1.5 KiB
Markdown
54 lines
1.5 KiB
Markdown
# Announcement Hooks
|
|
|
|
This hook allows the issues opened on your application repository to be displayed on the alliance auth front page to
|
|
administrators.
|
|
|
|
|
|
|
|
To register an AppAnnouncementHook class, you would do the following:
|
|
|
|
```python
|
|
from allianceauth import hooks
|
|
from allianceauth.services.hooks import AppAnnouncementHook
|
|
|
|
|
|
@hooks.register('app_announcement_hook')
|
|
def announcement_hook():
|
|
return AppAnnouncementHook("Your app name", "USERNAME/REPOSITORY_NAME", AppAnnouncementHook.Service.GITLAB)
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: allianceauth.services.hooks.AppAnnouncementHook
|
|
:members: __init__
|
|
:undoc-members:
|
|
```
|
|
|
|
## Parameters
|
|
|
|
### app_name
|
|
|
|
The name of your application.
|
|
|
|
### repository_namespace
|
|
|
|
Here you should enter the namespace of your repository.
|
|
The structure stays the same for both GitHub and GitLab repositories. \
|
|
A repository with the url `https://gitlab.com/username/appname` will have a namespace of `username/appname`.
|
|
|
|
### Service
|
|
|
|
This variable is an enumeration of the class `AppAnnouncemementHook.Service`
|
|
|
|
It is mandatory to specify this variable so alliance auth contacts the correct API when fetching your repository issues.
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: allianceauth.services.hooks.AppAnnouncementHook.Service
|
|
:members: GITLAB, GITHUB
|
|
:undoc-members:
|
|
```
|
|
|
|
### label
|
|
|
|
The label that will determine if issues should be seen as an announcement.
|
|
This value is case-sensitive and the default value is `"announcement"`.
|