This GitHub action allows you to quickly scaffold repositories using any selected Cookiecutter Template via Port Actions.

In addition, as cookiecutter is an Open Source project you can make your own project, learn more about it here

Follow these steps to get started with the Golang template

1. Create the following GitHub action secrets

• ORG_TOKEN - a PAT (Personal Access Token) with permissions to create repositories
• PORT_CLIENT_ID - Port Client ID learn more
• PORT_CLIENT_SECRET - Port Client Secret learn more

2. Install the Ports GitHub app from here.
3. Create a blueprint at Port with the following properties:

Note Keep in mind this can be any blueprint you would like and this is just an example

{
  "identifier": "microservice",
  "title": "Microservice",
  "icon": "Microservice",
  "schema": {
    "properties": {
      "description": {
        "title": "Description",
        "type": "string"
      },
      "url": {
        "title": "URL",
        "format": "url",
        "type": "string"
      },
      "readme": {
        "title": "README",
        "type": "string",
        "format": "markdown",
        "icon": "Book"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {}
}

4. Create an action at Port with the following JSON file:

Note Keep in mind that any field started with cookiecutter will automtically be injected into the cookiecutter inputs as a variable here for example we are using the cookiecutter_app_name input of the Golang Template

{
  "identifier": "scaffold",
  "title": "Scaffold Golang Microservice",
    "icon": "Git",
  "invocationMethod": {
    "type": "GITHUB",
    "org": "port-cookiecutter-example",
    "repo": "gha-templater",
    "workflow": "scaffold-golang.yml"
  },
  "trigger": {
    "type": "self-service",
    "operation": "CREATE",
    "userInputs": {
      "properties": {
        "name": {
          "title": "Repo Name",
          "type": "string"
        },
        "cookiecutter_app_name": {
          "type": "string",
          "title": "Application Name"
        }
      },
      "required": [
        "name"
      ]
    }
  }
}

5. Create a workflow file under .github/workflows/scaffold-golang.yml with the following content:

on:
    workflow_dispatch:
      inputs:
        port_payload:
          required: true
          description: "Port's payload, including details for who triggered the action and general context (blueprint, run id, etc...)"
          type: string
jobs: 
    scaffold:
      runs-on: ubuntu-latest
      steps:
        - uses: port-labs/[email protected]
          with:
            portClientId: ${{ secrets.PORT_CLIENT_ID }}
            portClientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
            token: ${{ secrets.ORG_TOKEN }}
            portRunId: ${{ fromJson(inputs.port_payload).context.runId }}
            repositoryName: ${{ fromJson(inputs.port_payload).payload.properties.name }}
            portUserInputs: ${{ toJson(fromJson(inputs.port_payload).payload.properties) }} 
            cookiecutterTemplate: https://github.com/lacion/cookiecutter-golang
            blueprintIdentifier: 'microservice'
            organizationName: INSERT_ORG_NAME

6. Trigger the action from Port UI.

If you would like to create a PR in a monorepo subfolder instead, you can fill out the following inputs

  monorepoUrl: <your-monorepo-url>
  scaffoldDirectory: <directory to scaffold in i.e apps/> 

To make sure all of the properties (like url, readme etc..) come directly from Github in a seamless way, you can connect our GitHub exporter next here you can find more information about it.