Mirror Repository Action

• Inputs
• Setup Instructions
• Example
• Tags
• Support
• Contributing

Mirror Git Repository to Remote Host.

Tip

Check out the Getting Started guide online.

Inputs

Input Name	Default Value	Short Description of the Input Value
url	or host	Full URL to Mirror; Overrides: host/owner/repo
host	or url	Full Host to Mirror; Example: https://codeberg.org
owner	Repo Owner	Repository Owner of Mirror (if different from source)
repo	Repo Name	Repository Name of Mirror (if different from source)
create	false	Set to true to attempt to Create the Mirror Repo
username	Repo Owner	Username for Authentication to Mirror
password	Required	Token or Password for Authentication to Mirror
summary	true	Add Job Summary. Set to false to Disable
private	Repo Private	If the Mirror Repo Status is Different from Source

url/host

You must provide either a full repository url or a host value.
Example: https://github.com/cssnr/mirror-repository-action

owner/repo

If different from source, you must specify these values (overridden by url).

create

Tested with Codeberg but should also work with Gitea/Forgejo. Set to true to enable.

username

Authentication username if different from owner.

password

Authentication password or token associated with the username.

summary

Write a Summary for the job. To disable this set to false.

👀 View Example Job Summary

---

✅ Successfully Mirrored: cssnr/mirror-repository-action

• https://codeberg.org/cssnr/mirror-repository-action

Results

remote:
remote: Create a new pull request for 'updates':
remote:   https://codeberg.org/cssnr/mirror-repository-action/compare/master...updates
remote:
To https://codeberg.org/cssnr/mirror-repository-action
   eaadc3f..da84f34  origin/updates -> updates

---

private

If the Mirror Repo Status is Different from Source.

Setup Instructions

1. Create a Token for Mirror to use as a Password for Pushing Commits, or Creating Repositories.

   • Codeberg/Gitea/Forgejo go here: https://codeberg.org/user/settings/applications
   • Select Permissions: write:organization write:repository write:user

2. Create Remote Repository to Mirror (or set create to true for codeberg.org).

3. Go to the settings for your source repository on GitHub and add the CODEBERG_TOKEN secret.

   • For organizations, you can add the token one time at the Organization level.

4. Add the following file to source repository on GitHub: .github/workflows/mirror.yaml

   • The owner is automatically set to the GitHub Organization or Username if personal. Set to override.
   • The repo is automatically set to the GitHub Repository Name. This should only be set to rename repo.
   • For Codeberg, use the host to https://codeberg.org and set the username to your Codeberg username.

Tip

This process has been automated with a Web Extension.
However, currently requires manual installation: cssnr/github-extension

Example

The below yaml is available in this file: .github/workflows/mirror.yaml

name: 'Mirror'

on:
  workflow_dispatch:
  push:
    branches: ['**']
    tags: ['**']

jobs:
  mirror:
    name: 'Mirror'
    runs-on: ubuntu-latest
    timeout-minutes: 5

    steps:
      - name: 'Checkout'
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: 'Mirror to Codeberg'
        uses: cssnr/mirror-repository-action@v1
        with:
          #url: https://codeberg.org/cssnr/mirror-repository-action
          host: https://codeberg.org
          #owner: cssnr
          #repo: mirror-repository-action
          create: true
          username: shaner
          password: ${{ secrets.CODEBERG_TOKEN }}

Important

Checkout with: fetch-depth: 0 is necessary!

For more examples, you can check out other projects using this action:
https://github.com/cssnr/mirror-repository-action/network/dependents

Tags

The following rolling tags are maintained.

Version Tag	Rolling	Bugs	Feat.	Name	Target	Example
	✅	✅	✅	Major	vN.x.x	vN
	✅	✅	❌	Minor	vN.N.x	vN.N
	❌	❌	❌	Micro	vN.N.N	vN.N.N

You can view the release notes for each version on the releases page.

The Major tag is recommended. It is the most up-to-date and always backwards compatible. Breaking changes would result in a Major version bump. At a minimum you should use a Minor tag.

Support

For general help or to request a feature, see:

• Q&A Discussion: https://github.com/cssnr/mirror-repository-action/discussions/categories/q-a
• Request a Feature: https://github.com/cssnr/mirror-repository-action/discussions/categories/feature-requests

If you are experiencing an issue/bug or getting unexpected results, you can:

• Report an Issue: https://github.com/cssnr/mirror-repository-action/issues
• Chat with us on Discord: https://discord.gg/wXy6m2X8wY
• Provide General Feedback: https://cssnr.github.io/feedback/

For more information, see the CSSNR SUPPORT.md.

Contributing

If you would like to submit a PR, please review the CONTRIBUTING.md.

Please consider making a donation to support the development of this project and additional open source projects.

Additionally, you can support other GitHub Actions I have published:

• Stack Deploy Action
• Portainer Stack Deploy Action
• Docker Context Action
• VirusTotal Action
• Mirror Repository Action
• Update Version Tags Action
• Docker Tags Action
• Update JSON Value Action
• JSON Key Value Check Action
• Parse Issue Form Action
• Cloudflare Purge Cache Action
• Mozilla Addon Update Action
• Package Changelog Action
• NPM Outdated Check Action
• Label Creator Action
• Algolia Crawler Action
• Upload Release Action
• Check Build Action
• Web Request Action
• Get Commit Action

❔ Unpublished Actions

These actions are not published on the Marketplace, but may be useful.

• cssnr/draft-release-action - Keep a draft release ready to publish.
• cssnr/env-json-action - Convert env file to json or vice versa.
• cssnr/push-artifacts-action - Sync files to a remote host with rsync.
• smashedr/update-release-notes-action - Update release notes.
• smashedr/combine-release-notes-action - Combine release notes.

---

📝 Template Actions

These are basic action templates that I use for creating new actions.

• js-test-action - JavaScript
• py-test-action - Python
• ts-test-action - TypeScript
• docker-test-action - Docker Image

Note: The docker-test-action builds, runs and pushes images to GitHub Container Registry.

---

For a full list of current projects to support visit: https://cssnr.github.io/