Code Monkey home page Code Monkey logo

enki's Introduction

Enki

Release Version Docker Pulls Codacy Badge Codacy Coverage

  1. Why
  2. Set Up With Maven
  3. Set Up With Gradle
  4. Running With Docker
  5. Core Concepts
  6. Providers:
    • Bitbucket
    • Github
    • Gitlab
    • Gitea
  7. Handlers:
    • Add Discord commit hook
    • Mirror repo to Gitea
    • Archive GitHub repo
    • Sync with GoCD
    • JaCoCo configurator for maven projects
    • Print a list of found repositories
    • Collect all dependency from maven project
  8. Cli/Server Runner
  9. Roadmap

Why

Sometimes we want to do some work with multiple repositories - add step with SonarQube to all pipelines, add JaCoCo to all projects, up library version everywhere, add helm charts, etc. There is where Enki can help you.

Enki takes all the problems with handling of cloning and iterating over multiple repositories, commiting and pushing them. All you need to do is write or reuse some handler which takes metadata and local cloned copy of repository and just does required job.

Set Up with Maven

Add to pom.xml

<repositories>
    <repository>
      <id>jcenter</id>
      <url>https://jcenter.bintray.com/</url>
    </repository>
</repositories>
<dependency>
  <groupId>com.github.stcarolas.enki</groupId>
  <artifactId>enki-core</artifactId>
  <version>0.1.49</version>
  <type>pom</type>
</dependency>

Set Up with Gradle

Add to build.gradle

repositories {
    jcenter()
}
implementation 'com.github.stcarolas.enki:enki-core:0.1.49'

Running with Docker

Docker image includes a launcher and all RepoProviders but no handlers. RepoHandlers must be provided via volume like -v $(pwd):/tmp as in examples below or packaged in custom image.

Cli mode:

docker run -v $(pwd):/tmp stcarolas/enki \
    --github --github-username=stCarolas --github-password=252f939e823c441fc7a2f5914e93a9fe30725b3c \
    /tmp/enki-logging-handlers-0.1.5.jar 

Server mode:

docker run -v $(pwd):/tmp -p 8080:8080 stcarolas/enki \
    --server \
    --github --github-username=stCarolas --github-password=252f939e823c441fc7a2f5914e93a9fe30725b3c \
    /tmp/enki-logging-handlers-0.1.5.jar 

enki's People

Contributors

codacy-badger avatar guchman avatar stcarolas avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

enki's Issues

tests on gitea-mirror

Enki/TODO

Lines 7 to 11 in 996e4c0

TODO tests on gitea-mirror
TODO tests on github-archive-repo
TODO tests on gocd-handlers
TODO tests on jacoco
TODO tests on logging-handlers


This issue was generated by todo based on a TODO comment in 996e4c0.

Global Variables

  1. формат файла с глобальными переменными, на которые могут смотреть и шаблоны и прочие аналайзеры
  2. чтение глобальных переменных в POJO
  3. возможно, бд с динамической таблицей для хранения контекста

tests on discord-commit-hook

Enki/TODO

Lines 6 to 11 in 996e4c0

TODO tests on discord-commit-hook
TODO tests on gitea-mirror
TODO tests on github-archive-repo
TODO tests on gocd-handlers
TODO tests on jacoco
TODO tests on logging-handlers


This issue was generated by todo based on a TODO comment in 996e4c0.

RepoRegistry

  1. хранить in memory маппинг git url (другой repo id?) - local clone
  2. прежде чем клонить репу для аналайзера, проверять, есть ли она в registry. Если есть, использовать уже имеющуюся

test for defaultGitOpenFn in GitPushUploadStrategy

// todo test for defaultGitOpenFn in GitPushUploadStrategy
public static final Function1<File, Option<Git>> defaultGitOpenFn = directory ->
Try(() -> Git.open(directory))
.onFailure(
error -> log.error( "error while acessing repository aborting push: {}", error)
)


This issue was generated by todo based on a todo comment in 2e82f1c.

Проверять, все ли поля заполнены из default.json

  1. Расширить default.json - в пару название "параметра - дефолтное значение", добавить описание
  2. перед генерацией проверять, есть ли у каждой переменной из default.json значение. Если нет, не запускать генерацию и предложить пользователю ввести отсутствующие переменные.

Описание параметров при создании pipeline

  1. Неочевидно откуда берутся доступные шаблоны. Было бы понятней, если бы было описание, что это репозитории в https://git.service.mango.rocks/Mango
  2. Было бы удобно, если бы после выбора шаблона Enki выводил текст из readme.
  3. Неочевидна история с маппингом, когда надо его заполнять, когда не надо, и как правильно.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.