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 the project and set its slug
Keep the suggested name or enter a clearer one. The form fills Project slug from the name. Edit the slug when the URL should use a different value. Select Create project.
The project slug is unique within the workspace. Shipfox uses it in client URLs
such as /w/acme/p/checkout-api/runs. If you rename the project later, links and
bookmarks that use the old slug stop working. The old slug becomes available for
another 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: shipfox
triggers:
manual:
source: manual
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.