cucumber / action-publish-subrepo

GitHub Action to publish a subdirectory of a repo to a read-only mirror

Publish Subrepo

GitHub Action to publish a subdirectory of a repo to a read-only mirror.

No matter what branch the action runs on, the main branch will be published to the mirror repo. Tags will be pushed too.

The name of the target repo to mirror into is inferred from the repo where the action is running and the given working-directory.

e.g.

working_directory: "go"
github.repositoryUrl: "https://github.com/cucumber/messages"
=> https://github.com/cucumber/messages-go

If the mirror repo does not already exist, it will be created.

No shallow clones!

The script cannot work without a full-depth clone of the repo. To do this using the actions/checkout github action you need:

- uses: actions/checkout@v2
  with:
    fetch-depth: '0'

Inputs

• working-directory - subfolder path within your repo that you want to mirror
• github-token - a PAT with sufficient privileges to create and push to the subrepo
• create-subrepo-if-missing (optional, default: true) - whether or not to create the subrepo if it doesn't exist yet

Example

name: Publish `php` folder to subrepo

on:
  push:
    branches:
      - "release/*"

jobs:
  publish-ui:
    name: Publish php folder to subrepo
    runs-on: ubuntu-latest
    environment: Release
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: '0'
      - uses: cucumber/action-publish-subrepo@v1.0.0
        with:
          working-directory: "php"
          github-token: ${{ secrets.PUSH_TOKEN }}