gickup-action

A GitHub Action for backing up any git repositories using gickup

Usage

Create a .github/gickup.yml file in your repository with your preferred configuration:

# Example gickup configuration
source:
  # Your source repository configuration goes here
destination:
  # Your source repository configuration goes here

Please refer to the gickup documentation for more information on how to configure your backup.

Create a .github/workflows/backup.yml file in your repository with the following content:

name: backup

on:
  push:
  workflow_dispatch:

jobs:
  backup:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Run gickup
      uses: socheatsok78/gickup-action@main

Note

By default, the action will look for a .github/gickup.yml file in your repository. If you have a different configuration file, you can specify it using the config input. See the Inputs section for more information.

Inputs

• config: The path to the gickup configuration file. Default: .github/gickup.yml
• dryrun: Whether to run gickup in dry-run mode. Default: false
• debug: Whether to run gickup in debug mode. Default: false