Quickstart

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
2. Authorize GitHub for user authentication
3. Click "Connect GitHub" when prompted
4. Install the GitHub App:
   • Select your organization
   • Choose repository access (you can start with specific repos)
   • Authorize the required permissions
   • Close the popup window

Access the Application

Once you authorize the CodeCargo GitHub app, our backend will create your environment and dashboards. When it's done, your browser tab will automatically be redirected and you are ready to start using the app.

Step 2: Import a Workflow

Importing workflows to CodeCargo is incredibly easy. Follow these steps to import a GitHub Actions Reusable Workflow into the platform.

1. Click on "Building Blocks" in the left navbar
2. Click "+ Add Workflow" on the top-right of the screen
3. Select a repository, path, and ref (GitHub branch, commit, or tag) for your workflow
4. Enter a description
5. Select an icon
6. Click the "Submit" button

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

Self-Service Workflows allow you to provide strong automation controls and functionality to your users. To create a Self-Service Workflow, you need to import at least 1 GitHub Actions Reusable Workflow as a Building Block. For your first SSW, you should pick something relatively simple or with well-defined inputs.

Create a Project

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

1. Navigate to Projects in the sidebar
2. Click "Create Project"
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

Create & Configure a Self-Service Workflow

1. Go to your Project
2. Click "Create a Self-Service Workflow"
3. Select a workflow from your Building Blocks
4. Configure the workflow:
   • Version: Branch or Tag name of the workflow to run
   • Name: Name of the Self-Service Workflow to create
   • Icon: Icon to display for the Self-Service Workflow
   • Description: Description of the Self-Service Workflow
5. Select the GitHub repository where the workflow will run
6. Configure the inputs for the workflow form

Step 4: Run Your First Workflow

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

1. Navigate to the Project
2. See all available workflows as cards
3. Click "Run Workflow" on the Self-Service Workflow card you just created
4. Fill out the form with the necessary parameters
5. Click "Submit"

What Happens Next