https://github.com/obalunenko/scrum-report

Daily stand up meeting scrum report generator in markdown format for slack
https://github.com/obalunenko/scrum-report

agile go golang report-generator scrum scrum-meetings stand-up

Last synced: 5 months ago
JSON representation

Daily stand up meeting scrum report generator in markdown format for slack

• Host: GitHub
• URL: https://github.com/obalunenko/scrum-report
• Owner: obalunenko
• License: mit
• Created: 2019-04-14T09:46:06.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2025-01-25T02:26:27.000Z (over 1 year ago)
• Last Synced: 2025-01-25T03:21:32.528Z (over 1 year ago)
• Topics: agile, go, golang, report-generator, scrum, scrum-meetings, stand-up
• Language: Go
• Homepage:
• Size: 17.4 MB
• Stars: 6
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
![coverbadger-tag-do-not-edit](https://img.shields.io/badge/coverage-8.33%25-brightgreen?longCache=true&style=flat)

[![GO](https://img.shields.io/github/go-mod/go-version/oleg-balunenko/scrum-report)](https://golang.org/doc/devel/release.html)

[![Go [lint, test]](https://github.com/obalunenko/scrum-report/actions/workflows/go.yml/badge.svg)](https://github.com/obalunenko/scrum-report/actions/workflows/go.yml)

[![Lint & Test & Build & Release](https://github.com/obalunenko/scrum-report/actions/workflows/release.yml/badge.svg)](https://github.com/obalunenko/scrum-report/actions/workflows/release.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/obalunenko/scrum-report)](https://goreportcard.com/report/github.com/obalunenko/scrum-report)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=obalunenko_scrum-report&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=obalunenko_scrum-report)

[![GoDoc](https://godoc.org/github.com/obalunenko/scrum-report?status.svg)](https://godoc.org/github.com/obalunenko/scrum-report)

[![Latest release artifacts](https://img.shields.io/github/v/release/obalunenko/scrum-report)](https://github.com/obalunenko/scrum-report/releases/latest)

[![Docker pulls](https://img.shields.io/docker/pulls/olegbalunenko/scrum-report)](https://hub.docker.com/r/olegbalunenko/scrum-report)

[![License](https://img.shields.io/github/license/obalunenko/scrum-report)](/LICENSE)

# scrum-report

Daily stand up meeting scrum report generator in markdown format for slack

## Template

    ```text

        *What did I do*

        •

        *What will I do*

        •

        *Impediments*

        •

    ```

## Usage of scrum-report

1. Download executable

   file: [![Latest release artifacts](https://img.shields.io/github/v/release/obalunenko/scrum-report)](https://github.com/obalunenko/scrum-report/releases/latest)

2. Unrar archive.

3. a. Run executable `scrum-report` with necessary flags. (see bellow list of available flags)

   b. Run docker-compose `docker-compose -f ./docker-compose.yml up --build -d`

   c. Pull image from docker and run it with set ENV variables (see bellow list of available variables)

Environment variables used:

```env

    SCRUM_REPORT_APP_PORT: Application listen port.

    SCRUM_REPORT_APP_NAME: Application service name

    SCRUM_REPORT_LOG_LEVEL: Outout log level

    SCRUM_REPORT_LOG_FORMAT: Log format (json or text)

    SCRUM_REPORT_LOG_SENTRY_DSN: Sentry DSN, if empty - disabled

    SCRUM_REPORT_LOG_SENTRY_TRACE_ENABLE: Enable sentry tracing.

    SCRUM_REPORT_LOG_SENTRY_TRACE_LEVEL: Sentry Tracing level.

```

Flags used:

```bash

  -help bool

        Output help for usage.

  -app_name string

    	app service name (default "scrum-report")

  -app_port string

    	app port (default "8080")

  -log_format string

    	Format of logs (supported values: text, json (default "text")

  -log_level string

    	set log level of application (default "INFO")

  -log_sentry_dsn string

    	Sentry DSN

  -log_sentry_trace_enable

    	Enables sending stacktrace to sentry

  -log_sentry_trace_level string

    	The level at which to start capturing stacktraces (default "PANIC")

```

#### Demo

![first step](.github/images/img1.png)

![first step](.github/images/img2.png)

![first step](.github/images/img3.png)