Skip to content
Permalink
Browse files
[FLINK-22032] add minimal README
  • Loading branch information
knaufk committed Apr 12, 2021
1 parent 0561a81 commit 1709d0456fc50530f3b84dd7d2c4a29193b0aaec
Showing 1 changed file with 55 additions and 0 deletions.
@@ -0,0 +1,55 @@
# Apache Flink Jira Bot

The Flink Jira enforces some of the rules outlined in [the Apache Flink Confluence](https://cwiki.apache.org/confluence/display/FLINK/Flink+Jira+Process).

## Usage

```
./venv/bin/python3 flink_jira_bot.py --help
usage: flink_jira_bot.py [-h] [-d] [-c CONFIG]
Apache Flink Jira Bot
optional arguments:
-h, --help show this help message and exit
-d, --dry-run no action on Jira, only logging
-c CONFIG, --config CONFIG
path to config file (default: config.yaml)
```

There are also `make` targets for the important actions:

### Run
```
make run
```

### Dry-Run

The dry-run does not make any changes to the Apache Flink Jira, but instead only logs the actions it would do.

```
make dry-run
```

### Configuration

Both `make run` and `make dry-run` look for the password of `flink-jira-bot` in an environment variable called `JIRA_PASSWORD`.

The configuration of the rules can be found in [config.yaml](config.yaml).

## About the Rules

### Rule 1 (not implemented yet)

### Rule 2 (not implemented yet)

### Rule 3

An unresolved Minor ticket without an update for {stale.minor.stale_days} is closed after a warning period of {stale.minor.warning_days} with a comment that encourages users to watch, comment and simply reopen with a higher priority if the problem insists.

## About Apache Flink

Apache Flink is an open source project of The Apache Software Foundation (ASF).

Flink is distributed data processing framework with powerful stream and batch processing capabilities. Learn more about Flink at http://flink.apache.org/

0 comments on commit 1709d04

Please sign in to comment.