Interact with git repository in your steps

Problem

Woodpecker provides a clone step for cloning the repository into the workspace but does not expose username and password for interacting with the git repository in subsequent steps.
If your pipeline steps need to interact with the git repository (be it a simple git fetch, update the version of a project npm version minor or a complete gitflow release process) you have to provide a means to do so.
This is how to provide all subsequent steps in the pipeline with access to the repo it was cloned from.

Recipe

Create a user in the forge who has the required permissions on the repo
Create a ssh key for that user and add the public key to the forge
Add the private key of this user to woodpecker (either global, repo or pipeline level) using the name WOODPECKER_SSH_KEY

Add this to your pipeline before the steps which require access to the git repository:

pipeline:
  - name: Provide access to git repo
    image: woodpeckerci/plugin-git
    secrets:
      - WOODPECKER_SSH_KEY
    commands:
      # Prepare ssh key to use with git      
      - echo "$${WOODPECKER_SSH_KEY}" >  $(pwd)/.git/woodpecker.key 
      - chmod 600 $(pwd)/.git/woodpecker.key 
      # Define git user
      - git config --local user.email "woodpecker-ci@example.com"
      - git config --local user.name "Woodpecker-CI"
      - git config --local core.sshCommand 'ssh -i $(pwd)/.git/woodpecker.key -o StrictHostKeyChecking=no'     
      # Change url of origin from http to ssh
      - SSH_REPO_URL=$$(git remote get-url origin | sed -E -e "s/https?:\\/\\//git@/g" -e "s/\\//:/") 
      - git remote set-url origin $${SSH_REPO_URL}

Of course you can change the name of the secret of the ssh key, the gut user name and git user email to your taste.

Here is an example on how to interact with the repo in the next step. The only thing required is an image with git installed.

      - name: Use git credentials  
        image: woodpeckerci/plugin-git
        commands:
          - git fetch

The recipe abuses the .git repository to persist the ssh key file between different steps. The reason for this is thet .git is ignored by git and you do not get untracked file you would have otherwise to care about. Usually on would place a proper config in ~/.ssh/config, but this does not persist between steps.

Uh oh!

Add a cookbook #316

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions