jhodges/GiteaBot-examples
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
James 2019-09-07 10:54:24 +01:00
parent 15927f86f2
commit 7b2cfb3e67
1 changed files with 87 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
View File

@ -1,3 +1,89 @@
Examples for GiteaBot
Examples for [jhodges/GiteaBot](https://git.jhodges.co.uk/jhodges/GiteaBot)
Copy config.php.dist to config.php and set your Gitea instalce URL and bots user/pass.
All examples include setup.php which loads the autoloader and config, connects to the Gitea instance specified in config, passes the command line args, and opens the repo specified on command line. After this $client and $repo will be available.
----
###[src/test.php](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/test.php)
```plain
/************************************************
* Simple example to create a new label and issue
*************************************************/
```
----
###[src/repeat.php](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/repeat.php)
```plain
/***********************************************************************
* This is designed to allow the use of labels to reopen recuring issues
* on a specific day, month or duration (daily/weekly/monthly etc)
* NOTE: This is not 100% implemented/tested. It's a WIP
* It will process any issue that is tagged with 'xxx/repeat' label
* The labels are grouped into days/months
* If an issue is closed then it will be reopened
* If an issue is already open the bot will comment "NAG!" about it
***********************************************************************/
```
----
###[src/edit.php](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/edit.php)
```plain
/*******************************************************
* This will loop through all issues and add some custom
* text to the issue body. It will use a placeholder so
* that it can be automatically updated without replacing
* the whole issue body
********************************************************/
```
----
###[src/delete_nags.php](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/delete_nags.php)
```plain
/**************************************************************
* This will delete all comments that match a specific keyword
* 1. Process all issues that match "NAG!":
* 2. Delete any comments that body exactly match "NAG!"
**************************************************************/
```
----
###[src/delete_labels.php](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/delete_labels.php)
```plain
/****************************************************
* This will loop through a list of label names
* If the label exists on the repo, delete the label
****************************************************/
```
----
###[src/delete_me.php](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/delete_me.php)
```plain
/**************************************************
* this will process all issues titled "delete me":
* 1. remove all labels
* 2. close the issue
* 3. change the title to "deleted"
**************************************************/
```
----
###[src/no_label_milestone.php](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/no_label_milestone.php)
```plain
/***************************************************************************************************************
* 1. Adds a 'no-milestone' label to any issues with no milestone
* 2. Removes the 'no-milestone' label if present on an issue with a milestone
* 3. Adds a 'no-label' label to any issues with no labels (excluding 'no-label' and 'no-milestone')
* 4. Removes the 'no-label' label if present on an issue with a label (excluding 'no-label' and 'no-milestone')
****************************************************************************************************************/
```
----
###[src/close_all.php](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/close_all.php)
```plain
/******************
* close ALL issues
******************/
```