Create and Configure Your Project
Create a new Project, install Warp’s GitHub App, and configure the Project.
Last updated
Was this helpful?
Create a new Project, install Warp’s GitHub App, and configure the Project.
Last updated
Was this helpful?
In Warp, a Project is an object for managing the migration of repositories to GitHub. Typically, you’ll create a new project for a specific migration engagement, such as moving a collection of repositories for an organization, department, team, or development project.
In this section, you’ll set up a Project by creating it, installing the Warp GitHub app for the organization, and configuring the Project.
At the end of this section, you will have a new Warp project.
🛠️ Open a browser tab or window to the Warp web application at warp.packfiles.io:
🛠️ Click the Sign in with GitHub button and sign in to Warp using your GitHub account.
Upon signing in, you will be taken to Warp’s Projects page, which lists your current migration projects:
At the bottom of the list of projects, you’ll see the Create a New Project area.
🛠️ Click anywhere on Create a New Project area to expand it.
The Create a New Project area will expand to display instructions for what to do next:
🛠️ Click the Install Warp from the GitHub Marketplace button.
A new browser will open to the GitHub Marketplace page for Warp’s GitHub app:
🛠️ Click the Add button near the upper right corner of the page or scroll to the bottom of the page. You should see the following:
At the bottom of the page, you’ll see the Account drop-down menu and the Install it for free button:
🛠️ In the Account menu, select the account for the destination organization — that is, the organization that you will be migrating repositories to.
The example destination organization for this quickstart is Hypotheticorp01.
🛠️ Click the Install it for free button.
You’ll be taken to the Review Your Order page:
🛠️ Review the order, then click the Complete order button.
You’ll go to the Install Packfiles Warp page, which will show:
That the Warp GitHub app will have access to all the repositories in the organization, and
What read, read/write, and admin permissions it will have within the organization and its repositories.
🛠️ Click the Install button at the bottom of the page.
You will return to the Warp web app, and can proceed to the next step.
You will be at the Welcome to Warp page:
🛠️ Click the Next button.
This will take to you the Configure Your Project page:
You can do two things on this page:
You can set the name of your project, or choose to keep the default name.
You can invite people on your team to become members of the project.
As the creator of the project, you don’t have to add yourself to the team. You are already a member of the project with Admin access.
🛠️ For this Quickstart, simply click the Next button.
You will arrive at the Connect Your Sources page. You’ll use it in the process of connecting your source and GitHub accounts to Warp:
When you created the project, Warp created a repository named Migration HQ for the GitHub organization that you selected earlier. Migration HQ will be the user interface for managing your migrations. It will be where you issue commands to Warp and it will keep track of which repositories to migrate and which ones have already been migrated.
🛠️ Let’s visit Migration HQ. Click the Migration HQ button, located in the Set Up Your Vault section:
A new browser tab or window will open, and you should see the Migration HQ page:
The files contained in Migration HQ are configuration and credentials files that Warp will use in the migration process. You will need to clone Migration HQ to your local computer, where you will create a vault file containing the following:
Credentials for accessing the repositories at the source (the place where you are migrating repositories from).
Credentials for accessing the destination GitHub organization (the place where you are migrating repositories to).
After creating the vault file, Warp will automatically push it to Migration HQ, making the credentials available to Warp, enabling it to migrate your repositories.
🛠️ Clone the Migration HQ repository to your local computer.
You’ve successfully set up your project — nicely done!
Make sure that you’ve cloned Migration HQ to your local computer, then proceed to the next step.
Search for the 🛠️ emoji if you’d like to skim through this content while focusing on the steps you need to follow.