Quickstart

Prefer to watch? This two-minute video goes from a newly connected organization to a finished Self-Service Workflow run: it adds a Building Block source, creates a project, configures a Self-Service Workflow with inputs and permissions, and runs it. The steps below cover the same ground, one clip at a time.

Step 1: Create Your Account

Account creation and user authentication is handled through GitHub. If you don't have a GitHub account, please create one before running through these steps.

Connect to GitHub

1. Sign in to CodeCargo at app.codecargo.com with your GitHub account.
2. On Create your CodeCargo organization, click Install CodeCargo App. Installing the app requires admin privileges on your GitHub organization; if you don't have them, the Can't Install? tab points you to our team.

3. Install the GitHub App in the GitHub window that opens:

   • Select your organization
   • Choose repository access (you can start with specific repos)
   • Authorize the required permissions

   The window closes when the installation finishes.

4. Wait for the sync. CodeCargo syncs your organization from GitHub (members, teams, repositories and workflows), then your own repository access, and shows its progress as it goes.

5. Pick your first repositories. Select up to 10 repositories and click Activate. Only active repositories appear in Actions Advisor, are monitored by CargoWall, and are available for Self-Service Workflows. You can activate more later, or click Skip for now.

Access the Application

When activation finishes, you land on your organization's dashboard. If you can activate repositories, Get started sits at the top until every step is done or skipped, or until you hide it. The dashboard fills in with activity as your teams use CodeCargo.

The guide follows the sidebar. A step shows only when your organization includes that area and you can use it:

• Activate repositories
• Add building blocks
• Run a self-service workflow
• Map your services
• Turn on guardrails
• Add CargoWall
• Connect what you migrate from
• Ask Dispatch

Each step checks itself off from your organization's data, so a step can already be done the first time you open the guide. Turn on guardrails, Add CargoWall, and Ask Dispatch finish on the guide: switches for your active repositories, the CargoWall snippet or Add to workflows, and an ask box with suggestions that opens Dispatch. The other steps link to the page where you finish them.

Skip sets a step aside for this organization. Open the step and click Undo to count it again. Hide getting started (the × on the guide) dismisses it. Skips and dismissal apply only to this organization, and the guide leaves once every remaining step is done or skipped.

Take the tour starts that area's tour, and Read the docs opens its documentation. You can also open tours and docs from the ? menu in the top bar, the Docs link in each page header, or the command palette (⌘K). The ? menu also includes Ask Dispatch, keyboard shortcuts, this quickstart, and release notes. Tours never start on their own. A tour highlights controls without blocking the page; arrow keys move between steps, and Esc closes it. On a page with nothing to show yet, the tour shows Sample data for this tour. That data is not yours, and it goes away when you leave the tour.

Step 2: Add Building Blocks

Building Blocks are the approved templates your teams build on: reusable workflows, actions and whole repositories. They come from sources, which are GitHub repositories CodeCargo discovers blocks in.

1. Click Building Blocks in the sidebar.
2. Click Add Source. (Once you have sources, use Add on the Sources tab.)
3. Select the repository that holds your reusable workflows.
4. Choose the version to track: a Branch, a Tag, or the Latest Release.
5. Choose the block types to discover (Workflows, Actions, Repository), then click Create Source.

6. CodeCargo lists the blocks it discovered. They start disabled, so turn on the ones you want in your catalog and click Done.

Step 3: Create a Self-Service Workflow (SSW)

Self-Service Workflows let your developers run a GitHub Actions workflow from a form in CodeCargo, with the controls you set. An SSW wraps a workflow that has a workflow_dispatch trigger in one of your project's repositories; that workflow typically calls the reusable workflows you added as Building Blocks. For your first SSW, pick something relatively simple or with well-defined inputs.

Create a Project

First, you need a Project because SSWs are members of Projects:

1. Open the project switcher at the top of the sidebar and choose All projects.
2. Click Create. (If this is your first project, the form opens right away.)
3. Configure your project:
   • Name: e.g., "Payment Service", "Frontend Apps", "Data Platform"
   • Description: Brief explanation of the project's purpose
   • Repositories: Select one or more GitHub repos to include
   • Icon: Optional icon for the project
4. Click Add Project. The new project opens on its dashboard.

Create & Configure a Self-Service Workflow

1. In your project, open Self-Service in the sidebar.

2. Click Create and choose Self-Service Workflow.

3. Select a repository, then a dispatchable workflow from it.

4. Configure the workflow:

   • Name: Name of the Self-Service Workflow
   • Icon: Icon to display for the Self-Service Workflow
   • Description: Description of the Self-Service Workflow (Markdown supported)
   • Git Ref: the branch or tag of the workflow to run

   Or check Generate details automatically to have CodeCargo write the name and description for you.

5. Configure the inputs for the workflow form: click an input in the preview to customize it. Here, the region input is restricted to two choices with friendly labels.

6. Click Save & Continue. On the Permissions step, choose who can run the workflow. GitHub App (Restricted) lets you add the specific users and teams. Click Done.

Step 4: Run Your First Workflow

Now that you created a Self-Service Workflow, it's time to run it.

1. Open Self-Service in your project to see its workflows as cards.

2. Click Run Workflow on the Self-Service Workflow card you just created.
3. Fill out the form with the necessary parameters.
4. Click Run Workflow. CodeCargo opens the run's page and follows it from Queued to In Progress to Success.

What Happens Next