Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/penguineer/redmineactionablescollector

Collect issues from Redmine that can be acted upon
https://github.com/penguineer/redmineactionablescollector

gtd microservice productivity redmine

Last synced: about 1 month ago
JSON representation

Collect issues from Redmine that can be acted upon

Host: GitHub
URL: https://github.com/penguineer/redmineactionablescollector
Owner: penguineer
License: mit
Created: 2020-01-30T14:24:33.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-06-07T09:22:07.000Z (7 months ago)
Last Synced: 2024-06-07T10:45:27.854Z (7 months ago)
Topics: gtd, microservice, productivity, redmine
Language: Python
Homepage: https://hub.docker.com/repository/docker/mrtux/redmine-actionables-collector
Size: 32.2 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

README

# Redmine Actionables

![PyTest](https://github.com/penguineer/RedmineActionablesCollector/actions/workflows/pytest.yml/badge.svg)
![Docker Image](https://github.com/penguineer/RedmineActionablesCollector/actions/workflows/docker-image.yml/badge.svg)

> Collect issues from Redmine that can be acted upon

An item is actionable when its action can be executed without further
prerequesites. A Redmine ticket is classified as actionable, when the
following apply:
* it is assigned to >>me<<
* it has started (past start date)
* it is not preceeded by other items
* has no open children
* its parent project is not closed

An actionable item can still be blocked, i.e. it may have open actions, but cannot be completed.

## Usage

### Configuration

Configuration is done using environment variables:

* `PORT`: Target port when used with docker-compose (default `8080`)

### Run with Docker

```bash
docker run --rm -it \
-p 8080:8080 \
mrtux/redmine-actionables-collector
```

### Run with Docker-Compose (Development)

To run with [docker-compose](https://docs.docker.com/compose/) copy [`.env.template`](.env.template) to `.env` and edit the necessary variables. Then start with:

```bash
docker-compose up --build
```

Please note that this compose file will rebuild the image based on the repository. This is helpful during development and not intended for production use.

When done, please don't forget to remove the deployment with
```bash
docker-compose down
```

## Maintainers

* Stefan Haun ([@penguineer](https://github.com/penguineer))

## Contributing

PRs are welcome!

If possible, please stick to the following guidelines:

* Keep PRs reasonably small and their scope limited to a feature or module within the code.
* If a large change is planned, it is best to open a feature request issue first, then link subsequent PRs to this issue, so that the PRs move the code towards the intended feature.

## License