https://github.com/jderusse/docker-gitsplit

https://github.com/jderusse/docker-gitsplit

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/jderusse/docker-gitsplit
• Owner: jderusse
• Created: 2016-07-22T20:34:11.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-12-04T16:50:06.000Z (almost 4 years ago)
• Last Synced: 2024-07-12T02:48:02.007Z (2 months ago)
• Language: Go
• Size: 50.8 KB
• Stars: 75
• Watchers: 6
• Forks: 10
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# A Docker image with git and splitsh-lite

See [the official site](https://github.com/splitsh/lite) for more information about splitsh.

Demo available here [jderusse/test-split-a](https://github.com/jderusse/test-split-a).

# Usage

Include a `.gitsplit.yml` file in the root of your repository.

This section provides a brief overview of the configuration file and split process.

Use env variable to inject your credential and manage authentication.

Example `.gitsplit.yml` configuration:

```yaml

# Path to a cache directory Used to speed up the split over time by reusing git's objects

cache_url: "/cache/gitsplit"

# cache_url: "file:///cache/gitsplit"

# cache_url: "https://${GH_TOKEN}@github.com/my_company/project-cache.git"

# cache_url: "[email protected]:my_company/project-cache.git"

# Path to the repository to split (default = current path)

# project_url: /home/me/workspace/another_project

# project_url: ~/workspace/another_project

# project_url: ../another_project

# project_url: file://~/workspace/another_project

# project_url: "https://${GH_TOKEN}@github.com/my_company/project.git"

# project_url: "[email protected]:my_company/project.git"

# List of splits.

splits:

  - prefix: "src/partA"

    target: "https://${GH_TOKEN}@github.com/my_company/project-partA.git"

  - prefix: "src/partB"

    target:

      # You can push the split to several repositories

      - "https://${GH_TOKEN}@github.com/my_company/project-partB.git"

      - "https://${GH_TOKEN}@github.com/my_company/project-partZ.git"

  - prefix:

      # You can use several prefix in the split

      - "src/subTree/PartC:"

      - "src/subTree/PartZ:lib/z"

    target: "https://${GH_TOKEN}@github.com/my_company/project-partC.git"

# List of references to split (defined as regexp)

origins:

  - ^master$

  - ^develop$

  - ^feature/

  - ^v\d+\.\d+\.\d+$

```

# Split your repo manualy

With a github token:

```

$ docker run --rm -ti -e GH_TOKEN -v /cache:/cache/gitsplit -v $PWD:/srv jderusse/gitsplit

```

With ssh agent:

```

$ docker run --rm -ti -e SSH_AUTH_SOCK=/ssh-agent -v $SSH_AUTH_SOCK:/ssh-agent -v /cache:/cache/gitsplit -v $PWD:/srv jderusse/gitsplit

```

# Sample with drone.io

Beware, the container have to push on your splited repository.

It could be a security issue. Use environments variables as defined in the official documentation

```yaml

# .gitsplit.yml

cache_url: "/cache/gitsplit"

splits:

  - prefix: "src/partA"

    target: "https://${GH_TOKEN}@github.com/my_company/project-partA.git"

origins:

  - ^master$

```

```yaml

# .drone.yml

pipeline:

  split:

    image: jderusse/gitsplit

    pull: true

    volumes:

      # Share a cache mounted in the runner

      - /drone/cache/gitsplit:/cache/gitsplit

      # Use ssh key defined in the runner

      - /drone/env/gitsplit.ssh:/root/.ssh/

    commands:

      # have to fetch remote branches

      - git fetch --prune --unshallow || git fetch --prune

      - gitsplit

```

# Sample with Travis CI

Beware, the container have to push on your splited repository.

It could be a security issue. Use environments variables as defined in the official documentation

```yaml

# .gitsplit.yml

cache_url: "/cache/gitsplit"

splits:

  - prefix: "src/partA"

    target: "https://${GH_TOKEN}@github.com/my_company/project-partA.git"

origins:

  - ^master$

```

```yaml

# .travis.yml

sudo: required

services:

  - docker

cache:

  directories:

    - /cache/gitsplit

install:

  - docker pull jderusse/gitsplit

  # update local repository. Because travis fetch a shallow copy

  - git config remote.origin.fetch "+refs/*:refs/*"

  - git config remote.origin.mirror true

  - git fetch --prune --unshallow || git fetch --prune

script:

  - docker run --rm -t -e GH_TOKEN -v /cache/gitsplit:/cache/gitsplit -v ${PWD}:/srv jderusse/gitsplit gitsplit --ref "${TRAVIS_BRANCH}"

```

# Sample with GitLab CI/CD

Beware, the container have to push on your splited repository.

It could be a security issue. Use environments variables as defined in the official documentation [GitLab SSH Deploy keys](https://docs.gitlab.com/ce/ssh/README.html#deploy-keys).

Note: I highly recommend to use ssh instead of https because of the username/password or username/token. Deploy keys are much easier to use with GitLab

```yaml

# .gitsplit.yml

cache_url: "cache/gitsplit"

splits:

  - prefix: "src/partA"

    target: "[email protected]:my_company/project-partA.git"

origins:

  - ^master$

```

```yaml

# .gitlab-ci.yml with Docker runners

stages:

  - split

split:

  image: jderusse/gitsplit

  stage: split

  cache:

    key: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME"

    paths:

      - cache/gitsplit

  variables:

    GIT_STRATEGY: clone

  before_script:

    - eval $(ssh-agent -s)

    - mkdir -p ~/.ssh

    - chmod 700 ~/.ssh

    - echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config

    - echo "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add - > /dev/null

    - ssh-add -l

  script:

    - git config remote.origin.fetch "+refs/*:refs/*"

    - git config remote.origin.mirror true

    - git fetch --prune --unshallow || git fetch --prune

    - gitsplit --ref "${CI_COMMIT_REF_NAME}"

```

# Sample with Github Actions

I recommend to not use [the checkout action](https://github.com/actions/checkout) because it will checkout only the last

commit for performance purpose. In this example we clone the whole repository. Indeed, if you need to split only the

last changes and you don't need to split tags, you can use it.

Also we do not use the GH Action auto-generated token because it doesn't have the required permissions for gitsplit to

work. You need to be able to write on all repositories you will split onto, you can create one by using following

link: [https://github.com/settings/tokens/new?scopes=repo,workflow&description=gitsplit](https://github.com/settings/tokens/new?scopes=repo,workflow&description=gitsplit)

In this example I trigger the gitsplit on main branch push and on Github release (tags), feel free to make it your way !

```yaml

name: gitsplit

on:

  push:

    branches:

      - main

  release:

    types: [published]

jobs:

  gitsplit:

    runs-on: ubuntu-latest

    steps:

      - name: checkout

        run: git clone https://github.com/org/project /home/runner/work/org/project && cd /home/runner/work/org/project

      - name: Split repositories

        uses: docker://jderusse/gitsplit:latest

        with:

          args: gitsplit

        env:

          GH_TOKEN: ${{ secrets.PRIVATE_TOKEN }}

```