octomation/maintainer

👨‍🔧 Contribution assistant for open-source projects.

maintainer's Issues

github: contribution: expand heat map by merging with neighbors

Now heat map truncated by year, because GitHub sliced them on this way. But, it will be great to expand it, e.g.

$ maintainer github contribution lookup 2013-12-31/5
 Day / Week                #51            #52           #1
--------------------- -------------- -------------- ----------
 Sunday                     -              -            -
 Monday                     -              -            -
 Tuesday                    -              2            -
 Wednesday                  -              2            ?
 Thursday                   4              -            ?
 Friday                     3              2            ?
 Saturday                   -              -            ?
--------------------- -------------- -------------- ----------
 Contributions are on the range from 2013-12-15 to 2013-12-31

maintainer github contribution lookup 2014-01-01/5
 Day / Week                #1            #2            #3
--------------------- ------------- ------------- ------------
 Sunday                     ?             -            -
 Monday                     ?             -            3
 Tuesday                    ?             -            -
 Wednesday                  -             -            2
 Thursday                   -             -            -
 Friday                     -             -            -
 Saturday                   -             -            -
--------------------- ------------- ------------- ------------
 Contributions are on the range from 2014-01-01 to 2014-01-18

So, /5 doesn't work, it is truncated by year, from left for 2014, and from right for 2013. Also, the result contains ? which means no data here.

• remove TrimByYear

			scope := xtime.
				RangeByWeeks(date, weeks, half).
				Shift(-xtime.Day).
				ExcludeFuture().
				TrimByYear(date.Year())

• extend to support many years

chm, err := service.ContributionHeatMap(cmd.Context(), date)

command: separate command structure and command execution

Motivation: it allows mock dependencies. Now it's difficult because the configuration is available only in runtime after a command call.

PoC:

func Runner(deps ...) func(cobra.Command, args) error {}

extend gh tool

• https://github.blog/2021-08-24-github-cli-2-0-includes-extensions/
• https://github.blog/2021-03-11-scripting-with-github-cli/

deps: up go-github to v45.0.0

Details are here https://github.com/google/go-github/releases/tag/v45.0.0.

implement github contribution diff command

$ maintainer github contribution diff --src=dump.2021.timestatmp1.json --dst=dump.2021.timestamp2.json
# compare two dumps and display the difference

$ maintainer github contribution diff --src=dump.2021.timestatmp1.json --dst=2021
# compare the dump and the current state of contribution heat map of 2021 year

github: contribution: extend heat map by .From(), .To(), and .Range()

It allows to integrate it with time.Range better.

deps: up go-github to v44.1.0

https://github.com/google/go-github/releases/tag/v44.1.0

big picture: labels

• defaults
• target
• mapping

sync with latest template

integrate markdown parser

I have to work with markdown files (e.g. README) to fetch some insides: link to mirror, to quality reports, to validate basic structure, etc.

Candidates:

• https://github.com/russross/blackfriday

command: labels classify issue

open a step-by-step form to provide valid labels for an issue

e.g.

1. is it a bug?
2. what does it have impact?
3. etc.

implement github contribution histogram command

$ maintainer github contribution histogram 2021
1 ##
2 #####
3 ###
4 #

implement github contribution lookup command

$ maintainer github contribution lookup 2021-02-01 --weeks=3
# shows contribution heat map for three weeks
# - week with the included date
# - one week before
# - one week after

how to warmup godoc and vanity url

when a new subpackage or package released

$ curl --data-urlencode 'path=go.octolab.org/toolkit/cli' \
  -H 'content-type: application/x-www-form-urlencoded' \
  https://godoc.org/-/refresh

improve vanity support

• case 1: dump

qase-tms/qase-go@ffaccae

• case 2: submodules

qase-tms/qase-go@e12c8ca

• case 3: submodules with different path

./reporters/<reporter> -> go.qase.io/reporter/<reporter>

• case 4: blob instead tree

label presets

Top level:

$ maintainer github labels dump --preset=octolab > .git/labels.yml
$ vim .git/labels.yml # to manual review and fixes
$ maintainer github labels update < .git/labels.yml

Low level:

• define classify tree
• find the most appropriate node
• find transform rule for preset
• replace it by the rule
• profit

ci/cd: tools: test act for local development

Motivation: test GitHub Actions quicker.

Project: https://github.com/nektos/act.

disable hub subcommands

maintainer/internal/command/root.go

Line 54 in 5a6acac

hub.New(githubToken),

command: github contribution lookup doesn't work well with now()

expected

obtained

$ maintainer github contribution lookup /2
 Day / Week               #17           #18           #19
-------------------- ------------- ------------- -------------
 Sunday                    -             -             -
 Monday                    -             -             -
 Tuesday                   -             -             -
 Wednesday                 -             -             -
 Thursday                  -             -             -
 Friday                    -             -             ?
 Saturday                  -             -             ?
-------------------- ------------- ------------- -------------
 Contributions are on the range from 2022-04-24 to 2022-05-12

org: define milestones

• v0.1.x

  GitHub Contributions Calendar

  Add commands to work with GCC.

• v0.2.x

  GitHub Labels

  Add commands to manage labels.

To do

• attach "contribution" issues to v0.1.x milestone

implement github contribution snapshot command

$ maintainer github contribution snapshot 2021 --format=json > dump.2021.json
# dump contribution heat map into stdout with json format

import go code from makefiles project

related to octomation/makefiles#22

implement doctoc

https://github.com/thlorenz/doctoc

import go code from vanity project

related to octomation/vanity#6

github: contribution: lookup shows incorrect scope for 1 week with now ts

$ maintainer github contribution lookup /1
 Day / Week                                    #18
---------------------------------- ---------------------------
 Sunday                                         6
 Monday                                         6
 Tuesday                                        6
 Wednesday                                      1
 Thursday                                       6
 Friday                                         6
 Saturday                                       6
---------------------------------- ---------------------------
 Contributions are on the range from 2022-05-01 to 2022-05-07

#19 needs to be shown

maintainer github contribution lookup /2
 Day / Week               #17           #18           #19
-------------------- ------------- ------------- -------------
 Sunday                    3             6             6
 Monday                    4             6             4
 Tuesday                   5             6             6
 Wednesday                 6             1             6
 Thursday                  6             6             6
 Friday                    6             6             4
 Saturday                  4             6             ?
-------------------- ------------- ------------- -------------
 Contributions are on the range from 2022-04-24 to 2022-05-13

#17 needs to be unshown

add possibility to compare configuration of repos

$ maintainer config compare octomation/maintainer kamilsk/retry
# shows the diff

optional if possible

$ maintaner config apply octomation/maintainer kamilsk/retry kamilsk/semaphore
# apply the diff

update github client

• https://github.com/google/go-github/releases/tag/v40.0.0
• https://github.com/google/go-github/releases/tag/v41.0.0
• https://github.com/google/go-github/releases/tag/v42.0.0
• https://github.com/google/go-github/releases/tag/v43.0.0
• https://github.com/google/go-github/releases/tag/v44.0.0

remove double new lines

input:

include src/common/env.mk

export PATH := $(GOBIN):$(PATH)

expected:

make-verbose:
	$(eval AT :=)
	$(eval MAKE := $(MAKE) verbose)
	@echo > /dev/null
.PHONY: make-verbose


export PATH := $(GOBIN):$(PATH)

obtained:

make-verbose:
	$(eval AT :=)
	$(eval MAKE := $(MAKE) verbose)
	@echo > /dev/null
.PHONY: make-verbose

export PATH := $(GOBIN):$(PATH)

contribution chart

Add a possibility to fetch contribution chart from GitHub and shows appropriate date correction for git commit.

$ maintainer contribution chart

$ git at $(maintainer contribution next) did something useful

org: prepare release v0.1.0

https://github.com/octomation/maintainer/releases/tag/untagged-b3dd1d314e99b98d5cdf

add dry-run option for github labels

to prevent execution and review the job plan "show, don't do"

update github client

• https://github.com/google/go-github/releases/tag/v37.0.0
• https://github.com/google/go-github/releases/tag/v38.0.0
• https://github.com/google/go-github/releases/tag/v38.1.0
• https://github.com/google/go-github/releases/tag/v39.0.0
• https://github.com/google/go-github/releases/tag/v39.1.0
• https://github.com/google/go-github/releases/tag/v39.2.0

integrate or implement embedmd

https://github.com/campoy/embedmd

transition entity

Transition describes the transformation from state X to state Y. It is useful for dry-run and more accurate patch appling.

For example:

LabelX {
  name: "x"
  color: "000"
}

LabelY {
  name: "y"
  color: "000"
}

Transition {
  name: { from: "x", to: "y" }
}

issue with modules without go files on the root

related to octomation/vanity#7

use contributions chart for git at suggestion

research

• https://github.com/sallar/github-contributions-chart
• https://github.com/Bloggify/github-calendar

acceptance criteria:

• algorithm finds holes
• defines "minimum" commits
• suggests date for git at -123d
• allows to view contributions chart without github

$ git at $(maintainer contribution suggest --for=2021) did something useful

github: contribution: extend support lookup for a month

It could be useful for exploratory

$ maintainer github contribution lookup 2013-11

command: github backup repository

allows you to store .git, issues, projects, labels, etc.

github: contribution: lookup forward/backward

now it split by half, I need a possibility to look forward or backward

$ maintainer github contribution lookup 2021-01-01/10
 Day / Week       #53      #1      #2      #3      #4     #5
--------------- -------- ------- ------- ------- ------- -----
 Sunday            ?        5      10       5       5      5
 Monday            ?        5      10       5       5      5
 Tuesday           ?        5      10       5       5      5
 Wednesday         ?        5      10       5       5      5
 Thursday          ?        5      10       5       5      5
 Friday            5        5      10       5       5      5
 Saturday          5        5      10       5       5      5
--------------- -------- ------- ------- ------- ------- -----
 Contributions are on the range from 2021-01-01 to 2021-02-06

$ maintainer github contribution lookup 2021-01-01/10 forward
$ maintainer github contribution lookup /10 backward

or

$ maintainer github contribution lookup 2021-01-01/+10
$ maintainer github contribution lookup /-10

and possibly allow autodetection

org: review and classify issues

• add prefix
• add to project
• close unnecessary

template: automate sync with upstream

• calculate diff
• propose changes

extend octolab preset by other repositories

candidates:

• new subset
  • kamilsk/workshops
  • octolab/docs
  • octolab/rfc
• delete (aka empty subset)
  • kamilsk/gex
• update
  • kamilsk/bridge (from defaults)
  • kamilsk/breaker
  • kamilsk/check
  • kamilsk/dotfiles
  • kamilsk/egg
  • kamilsk/genome
  • kamilsk/grafaman

also add

• possibility to mix labels: maintainer github labels patch octolab hacktoberfest
• possibility to remove labels: maintainer github labels patch empty

github: contribution: refactor command and view

Motivation: it contains technical debt.

Before releasing v0.1.0 I have to improve code quality.

define tool config

it allows improve the result of #33 and make configuration more clear

provide github access token by command flag

now it's provided by os env

fetch current state of labels of all repositories

dump it as columns in ordered rows

github: contribution: show datetime on the right side of lookup

for example

$ maintainer github contribution lookup 2021-03-13/1
 Day / Week                                    #10
---------------------------------- ---------------------------
 Sunday                                        10
 Monday                                        10
 Tuesday                                        8
 Wednesday                                     10
 Thursday                                      10
 Friday                                        10
 Saturday                                      10
---------------------------------- ---------------------------
 Contributions are on the range from 2021-03-07 to 2021-03-13

needs to be extended by right column with "last" dates

org: prepare release v0.2.0

• clean up code
• improve code quality (solve todo)
• write tests
• describe github labels commands

deps: up go-github to v45.1.0

Details are here https://github.com/google/go-github/releases/tag/v45.1.0.

research: automate update golangci-lint config

it generic for templates

• https://github.com/octomation/go-module/blob/master/.golangci.yml
• https://github.com/octomation/go-service/blob/master/.golangci.yml
• https://github.com/octomation/go-tool/blob/master/.golangci.yml