Shipfox
How-to GuidesSet Up Work

Create a Shipfox Project from a Repository

Connect one repository to a workspace. Check that Shipfox finds its workflows.

A project connects one repository to Shipfox.

Before you begin

You need a source integration connection that can read the repository. If you do not have one, connect GitHub first.

Create the project

Open the project form

Open your workspace, select Projects, then select New project.

Choose the source integration connection

Select the integration connection that can read the repository. If it is missing, create or repair the integration connection first.

Choose the repository

Select one repository from the integration connection. Shipfox looks for workflows in it. Project jobs also check out this repository.

Name and create the project

Keep the suggested name or enter a clearer one. Select Create project.

Verify workflow discovery

Add .shipfox/workflows/project-connection-check.yml to the repository. This is a complete workflow:

# yaml-language-server: $schema=https://www.shipfox.io/docs/workflow.schema.json
name: Project integration connection check
runner: ubuntu-latest

triggers:
  manual:
    source: manual
    event: fire

jobs:
  check:
    steps:
      - run: echo "Project checkout is available"

Commit the file to the default branch. Push it, then open the project's Workflows tab.

A successful sync lists the workflow. If the sync badge reports a failure, use Troubleshoot workflow sync.

You only need an online ubuntu-latest runner to start the workflow. Shipfox can find the workflow without a runner.

Was this page helpful?
Edit this page on GitHub

On this page