and more

Co-authored-by: kjuulh <contact@kjuulh.io>
Reviewed-on: https://git.front.kjuulh.io/kjuulh/kraken/pulls/11

CONFIGURATION_SERVER.md

@@ -1 +0,0 @@
-# Configuration server

README.md

@@ -1,249 +0,0 @@
-<p align="center">
-  <image src="https://git.front.kjuulh.io/kjuulh/kraken/raw/branch/v0.2/assets/kraken.svg" width="300" height="300"/>
-</p>
-<h1 align="center">Kraken - Your cute action executor</h1>
-
-## Purpose
-
-The goal of this project is to easily do batch changes or queries on a host of
-repositories. In large organisations using multi-repository strategies, it may
-be painful to change even small things across many repositories, because there
-are so many of them. Kraken aims to change that.
-
-**DISCLAIMER:** It is still early days, and the api is subject to change.
-
-## Features
-
-- Uses an actions repository, where you store all your pending commands or
-  queries to be performed across your fleet of repositories. (See \_examples)
-- Actions can both execute changes, open pull-requests or in some cases commit
-  directly to your preferred branch
-  - Actions natively use either shell, go or docker files to execute changes
-    (see \_examples/actions)
-- Actions can also be analytical, so you can query your fleet for whatever you
-  would like
-- Works both as a client, or as a server
-- Supports SSH/https for fetching repos
-- Supports GPG signing
-- Supports dry-run mode for easy testing when developing your actions (enabled
-  by default on the cli)
-
-## Roadmap
-
-Refer to [roadmap.md](roadmap.md)
-
-## Installation
-
-Kraken comes in two modes. Client or Client -> Server. Kraken can stand alone as
-a client, for smaller and less secure changes. However, for organisations, it
-may be useful to use Kraken in server mode, which supports more features, and
-has extra security built in.
-
-### Client (CLI)
-
-Download executable from [releases](https://github.com/kjuulh/kraken/releases)
-
-#### Or Use docker image
-
-```bash
-docker run --rm kasperhermansen/krakencli:latest version
-```
-
-#### Or Build from source
-
-```bash
-git clone https://github.com/kjuulh/kraken.git
-cd kraken
-
-go build cmd/kraken/kraken.go
-./kraken version
-```
-
-#### Or Build with cuddle
-
-```bash
-git clone https://github.com/kjuulh/kraken.git
-cd kraken
-
-cuddle_cli x build_cli
-```
-
-### Server
-
-We prefer to run the server directly as a docker image.
-
-```bash
-docker pull kasperhermansen/krakenserver:latest
-docker run -p 9090:80 --rm kasperhermansen/krakenserver:latest
-```
-
-#### Or Build from source
-
-```bash
-git clone https://github.com/kjuulh/kraken.git
-cd kraken
-
-go build cmd/server/server.go
-./server version
-```
-
-#### Or Build with cuddle
-
-```bash
-git clone https://github.com/kjuulh/kraken.git
-cd kraken
-
-cuddle_cli x build_server
-```
-
-## Usage
-
-**DISCLAIMER:** It is still early days, and the api of the CLI is subject to
-change, this provides the aim of the project, but as it is currently in flux,
-there may not be as much handholding in the actual usage.
-
-I will focus on the client here, as the server provides the same features,
-though available through the cli, but instead as configuration options (see
-[CONFIGURATION_SERVER.md](CONFIGURATION_SERVER.md))
-
-Kraken ships with autocomplete built in (courtesy of spf13/cobra). To add:
-
-- Bash: `echo 'source <(kraken completion bash)' >> ~/.bashrc`
-- Zsh: `echo 'source <(kraken completion zsh)' >> ~/.zshrc`
-
-### Creating a new action
-
-Creating a new action
-
-```bash
-git init my-actions # should only be done once
-cd my-actions
-kraken tmpl init write-a-readme --command
-cat write-a-readme/kraken.yml
-
-# Output
-# apiVersion: git.front.kjuulh.io/kjuulh/kraken/blob/main/schema/v1
-# name: write-a-readme
-# select:
-#   repositories: []
-# actions:
-#   - type: shell
-#     entry: "main.sh"
-```
-
-Kraken also ships with yaml schema, which should help write the yaml
-configuration.
-
-#### Add upstream repositories (victims)
-
-Now add a preferred repository
-
-```
-cat << EOF > write-a-readme/kraken.yml
-apiVersion: git.front.kjuulh.io/kjuulh/kraken/blob/main/schema/v1
-name: write-a-readme
-select:
-  providers:                           # new
-  - gitea: https://git.front.kjuulh.io # new
-    organisation: "kjuulh"             # new
-actions:
-  - type: shell
-    entry: "main.sh"
-EOF
-```
-
-This will take all your repositories under an organisation and run the script
-on.
-
-Another could be to use
-
-```bash
-cat << EOF > write-a-readme/kraken.yml
-apiVersion: git.front.kjuulh.io/kjuulh/kraken/blob/main/schema/v1
-name: write-a-readme
-select:
-  repositories:                                       #new
-    - git@git.front.kjuulh.io:kjuulh/kraken.git       #new
-    - git@git.front.kjuulh.io:kjuulh/kraken-test.git  #new
-actions:
-  - type: shell
-    entry: "main.sh"
-EOF
-```
-
-This will just apply to those repositories instead. Both can also be combined
-for a shared effect.
-
-### Execute action
-
-To run the script use
-
-```bash
-kraken process --path "write-a-readme"
-```
-
-This will cause the kraken process to automatically apply the action on the repo
-and open a pr.
-
-### Query repositories
-
-Kraken can also be used to query.
-
-```bash
-cat << EOF > write-a-readme/kraken.yml
-apiVersion: git.front.kjuulh.io/kjuulh/kraken/blob/main/schema/v1
-name: write-a-readme
-select:
-  repositories:
-    - git@git.front.kjuulh.io:kjuulh/kraken.git
-    - git@git.front.kjuulh.io:kjuulh/kraken-test.git
-queries:
-  - type: grep
-    query: "# README"
-EOF
-```
-
-Using the same command as above, will return the lines on each repo with those
-criteria. Everything is run in docker, even locally, so no need to install fancy
-tools.
-
-Do note: All actions will be run as dry-run unless `--apply` is added. This is
-to help test locally, as well as not cause serious issues. The server
-configuration is pretty much the same, except the command would look like so:
-`kraken server process --path "write-a-readme" --apply`. Kraken will try to
-infer as much as possible, but it may be needed to apply some extra flags to
-specify upstream repositories and such. Kraken will also help you setup keys and
-such on the first run, using `kraken setup` or `kraken server setup`.
-
-## Contributing
-
-It is still early days, and as such things are moving fast, I may not be able to
-implement features, because I am focusing my energy on the API. That said PRs
-are welcome, though they are at your own risk.
-
-### Bugs & features requests
-
-Please use [issues](https://github.com/kjuulh/kraken/issues)
-
-### Development
-
-We use [cuddle](https://git.front.kjuulh.io/kjuulh/cuddle) to improve ease of
-use, it is however, not a requirement, and probably won't need to be used
-outside core maintainers.
-
-Simply:
-
-```bash
-go run cmd/kraken/kraken.go # CLI
-go run cmd/server/server.go # Server
-```
-
-We follow the `gofmt` formatting, along with optionally but recommend `golines`
-
-If using cuddle
-
-```
-cuddle_cli x run # Run both server and client, will do a quick test sweep on the cli
-cuddle_cli x watch_run # Automatically refresh both
-cuddle_cli x fmt # will format the current code
-```

_examples/actions/add_releaserc/go.mod

@@ -1,11 +0,0 @@
-module write_a_readme
-
-go 1.19
-
-require github.com/bitfield/script v0.20.2
-
-require (
-	bitbucket.org/creachadair/shell v0.0.7 // indirect
-	github.com/itchyny/gojq v0.12.7 // indirect
-	github.com/itchyny/timefmt-go v0.1.3 // indirect
-)

_examples/actions/add_releaserc/go.sum

@@ -1,20 +0,0 @@
-bitbucket.org/creachadair/shell v0.0.7 h1:Z96pB6DkSb7F3Y3BBnJeOZH2gazyMTWlvecSD4vDqfk=
-bitbucket.org/creachadair/shell v0.0.7/go.mod h1:oqtXSSvSYr4624lnnabXHaBsYW6RD80caLi2b3hJk0U=
-github.com/bitfield/script v0.20.2 h1:4DexsRtBILVMEn3EZwHbtJdDqdk43sXI8gM3F04JXgs=
-github.com/bitfield/script v0.20.2/go.mod h1:l3AZPVAtKQrL03bwh7nlNTUtgrgSWurpJSbtqspYrOA=
-github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.7 h1:81/ik6ipDQS2aGcBfIN5dHDB36BwrStyeAQquSYCV4o=
-github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8/DtOE=
-github.com/itchyny/gojq v0.12.7 h1:hYPTpeWfrJ1OT+2j6cvBScbhl0TkdwGM4bc66onUSOQ=
-github.com/itchyny/gojq v0.12.7/go.mod h1:ZdvNHVlzPgUf8pgjnuDTmGfHA/21KoutQUJ3An/xNuw=
-github.com/itchyny/timefmt-go v0.1.3 h1:7M3LGVDsqcd0VZH2U+x393obrzZisp7C0uEe921iRkU=
-github.com/itchyny/timefmt-go v0.1.3/go.mod h1:0osSSCQSASBJMsIZnhAaF1C2fCBTJZXrnj37mG8/c+A=
-github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
-github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
-golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

_examples/actions/add_releaserc/kraken.yml

@@ -1,12 +0,0 @@
-apiVersion: git.front.kjuulh.io/kjuulh/kraken/blob/main/schema/v1
-name: write-a-readme
-select:
-  repositories:
-    - git@git.front.kjuulh.io:kjuulh/kraken-test.git
-    - git@git.front.kjuulh.io:kjuulh/kraken.git
-      #  providers:
-      #    - gitea: https://git.front.kjuulh.io
-      #      organisation: "cibus"
-actions:
-  - type: go
-    entry: "main.go"

_examples/actions/add_releaserc/main.go

@@ -1,25 +0,0 @@
-package main
-
-import "github.com/bitfield/script"
-
-func main() {
-
-	releaseRc := `
-  branches: 
-  - "main"
-  - "v0.x"
-
-  plugins:
-  - "@semantic-release/commit-analyzer"
-  - "@semantic-release/release-notes-generator"
-  - "@semantic-release/changelog"
-  - "@semantic-release/git"
-  `
-
-	_, err := script.
-		Echo(releaseRc).
-		WriteFile(".releaserc.yml")
-	if err != nil {
-		panic(err)
-	}
-}

_examples/queries/find_semantic/kraken.yml

@@ -1,9 +0,0 @@
-apiVersion: git.front.kjuulh.io/kjuulh/kraken/blob/main/schema/v1
-name: write-a-readme
-select:
-  providers:
-    - gitea: https://git.front.kjuulh.io
-      organisation: "cibus"
-queries:
-  - type: grep
-    query: "releaser"

assets/kraken.svg

@@ -1,10 +0,0 @@
-<svg width="1000" height="1000" viewBox="0 0 1000 1000" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path d="M975 568C975 830.335 762.335 497 500 497C237.665 497 25 830.335 25 568C25 305.665 237.665 93 500 93C762.335 93 975 305.665 975 568Z" fill="#52DB78"/>
-<path d="M237.436 856.185C165.693 827.571 320.875 755.464 377.754 612.854C434.634 470.243 371.672 311.132 443.414 339.746C515.157 368.36 527.205 507.165 470.326 649.776C413.446 792.386 309.178 884.799 237.436 856.185Z" fill="#52DB78"/>
-<path d="M428.353 849.847C353.918 829.229 500.308 740.627 541.293 592.663C582.278 444.699 502.337 293.405 576.773 314.023C651.208 334.641 678.325 471.303 637.34 619.267C596.355 767.231 502.788 870.465 428.353 849.847Z" fill="#52DB78"/>
-<path d="M598.707 855.902C523.231 839.498 664.415 742.813 697.024 592.781C729.634 442.748 641.321 296.183 716.797 312.588C792.272 328.992 827.022 463.916 794.413 613.948C761.803 763.98 674.183 872.307 598.707 855.902Z" fill="#52DB78"/>
-<path d="M47.896 838.855C-19.3259 800.817 144.17 750.323 219.784 616.698C295.397 483.073 254.495 316.918 321.717 354.956C388.938 392.994 382.136 532.155 306.522 665.78C230.909 799.405 115.118 876.893 47.896 838.855Z" fill="#52DB78"/>
-<ellipse cx="605.35" cy="265.255" rx="57.5" ry="36.5" transform="rotate(-40.9544 605.35 265.255)" fill="white"/>
-<ellipse cx="359.35" cy="265.255" rx="57.5" ry="36.5" transform="rotate(-40.9544 359.35 265.255)" fill="white"/>
-<path d="M385.635 374C385.635 374 391.199 435.298 463.528 438.425C535.857 441.553 538.492 380.61 538.492 380.61" stroke="white" stroke-width="8"/>
-</svg>

internal/logger/zap.go

@@ -12,7 +12,7 @@ func New() (*zap.Logger, error) {
 		return lvl >= zapcore.ErrorLevel
 	})
 	lowPriority := zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
-		return lvl < zapcore.ErrorLevel && lvl > zapcore.DebugLevel
+		return lvl < zapcore.ErrorLevel
 	})
 
 	config := zap.NewDevelopmentEncoderConfig()
@@ -28,6 +28,5 @@ func New() (*zap.Logger, error) {
 	)
 
 	logger := zap.New(core)
-
 	return logger, nil
 }

internal/services/providers/git.go

@@ -242,7 +242,7 @@ func (g *Git) CreateBranch(ctx context.Context, gitRepo *GitRepo) error {
 	err = worktree.PullContext(ctx, &git.PullOptions{
 		RemoteName:        "origin",
 		ReferenceName:     "refs/heads/main",
-		SingleBranch:      false,
+		SingleBranch:      true,
 		Depth:             1,
 		Auth:              auth,
 		RecurseSubmodules: 1,

roadmap.md

@@ -23,33 +23,22 @@
 - [x] Implement docker action
 - [x] Create pr for gitea provider
 - [x] Providing query results
-- [x] Create CLI to trigger action
+- [ ] Create CLI to trigger action
 
-## Version 0.2
+### Not in scope
 
-- [x] Write README
+## Version 1.0
+
+- [ ] Write README
 - [ ] Make configurable ssh user
 - [ ] Make configurable gpg keyset
 - [ ] Make configurable git provider
-  - [ ] Add github
+- [ ] Create templating function
-- [ ] Create templating function for easily creating new actions
 - [ ] Add way to see progress of runners
-- [ ] Implement global .kraken store for easy access to settings
+- [ ] Implement global .kraken store for easy access
-- [ ] Move builders to start instead of every building on every action
+- [ ] Move builders to start instead of every time
-- [ ] Setup releases on github
-- [ ] Setup CI
-- [ ] Setup static analysis
-- [ ] Setup releases on gitea using drone
-- [ ] Figure out a license (probably MIT)
 
-## Version 0.3
+## Version 1.x
-
-- [ ] Create setup version for local actions
-- [ ] Create setup version for server actions
-- [ ] Create json schema
-- [ ] Move roadmap to release / changelog
-
-## Version 0.x
 
 - Think about some sort of isolation
 - Run authenticated on servers

scripts/run_client.sh

@@ -4,8 +4,5 @@ set -e
 
 current_branch=$(git branch --show-current)
 
-#go run cmd/kraken/kraken.go process --actions-repo "git@git.front.kjuulh.io:kjuulh/kraken.git" --branch "$current_branch" --path "_examples/actions/write_a_readme"
+go run cmd/kraken/kraken.go process --actions-repo "git@git.front.kjuulh.io:kjuulh/kraken.git" --branch "$current_branch" --path "_examples/actions/write_a_readme"
-go run cmd/kraken/kraken.go process \
+go run cmd/kraken/kraken.go process --actions-repo "git@git.front.kjuulh.io:kjuulh/kraken.git" --branch "$current_branch" --path "_examples/queries/scrape_readme"
-  --actions-repo "git@git.front.kjuulh.io:kjuulh/kraken.git"\
-  --branch "$current_branch" \
-  --path "_examples/queries/find_semantic"