Developing with SAP Extension Suite

Creating and Connecting a GitHub Repository

Objectives
After completing this lesson, you will be able to:

After completing this lesson, you will be able to:

  • Create and connect a GitHub repository

Create and Connect a GitHub Repository: Exercise Overview

Scenario

In this exercise, you will create a public GitHub1 repository for the source code of your application.

Task Flow

In this exercise, you will perform the following tasks:

  • Create a public GitHub repository to store the source code of a project.
  • Create a personal access token for GitHub.
  • Connect a CAP project with a GitHub repository using git commands.

Prerequisite

To create a GitHub repository, you need a CAP project and a GitHub user. If you do not have a GitHub user, sign up for GitHub first.

Watching the Simulation and/or Performing the Steps

Note
In this exercise you find a simulation and a list of all steps, displayed in the simulation. Performing the steps below allows you to follow the simulation in your own trial account.

Create and Connect a GitHub Repository

Exercise

Create and Connect a GitHub Repository

Start Exercise

Task 1: Create a Public GitHub Repository

Steps

  1. Create a Public GitHub Repository to store the source code of a project.

    1. Open and sign in to https://github.com/.

    2. In the Repositories tab, choose New to create a new repository.

    3. As the Repository name, enter RiskManagement. Don't tick any of the Initialize this repository with checkboxes.

    4. Choose Create repository.

    5. Copy the HTTPS URL of your newly created GitHub repository.

Task 2: Create a Personal Access Token for GitHub

Steps

  1. Create a Personal Access Token for GitHub.

    To create a personal access token, which you can use instead of a password, follow the steps described in Creating a personal access token2.

Task 3: Connect Your GitHub Repository With Your CAP Project

You have created a new, empty GitHub repository. To be able to use it as a repository for your risk management application source code, you need to connect it with your CAP project. Until now, the only place where your project's source code resided was your personal dev space in SAP Business Application Studio.

Steps

  1. Connect Your GitHub Repository with Your CAP Project.

    1. Return to your SAP Business Application Studio.

    2. Open a new terminal and navigate to your project root folder.

    3. Enter your email address and username. You can use the email address that you've used to register your GitHub account:

      Code snippet
      
      git config --global user.email "you@example.com"
      git config --global user.name "Your Name"
      Copy code

      This configures the git command line tool locally in your Business Application Studio dev space. Now when you do file changes and commit them to a git history, git will use the configured name and email in these commits.

Task 4: Initialize the Local git Repository

Since we cloned the starter template from GitHub, we already have a GitHub repository. Therefore, we do not have to create a new local one. All we have to do is to commit all our recent changes, link the new GitHub repository with our local one and to push the changes to GitHub.

Steps

  1. Initialize the local git repository.

    1. Add all directories and files to the git staging area. Perform the command:

      Perform the command:git add.

    2. Create the first commit in your git repository.

      Perform the command:git commit -m "Push project content to GitHub"

    3. Add your copied GitHub repository URL from the previous part of the exercise as remote repository (without the angle brackets '<' and '>' ):

      Perform the command:git remote set-url origin <copied Git repository url.git>

      This tells your local git repository in the Business Application Studio dev space, that it has a remote counterpart on GitHub. The remote counterpart should act as the origin, thus it is the repository that you and your colleagues use as the central repository of your project.

    4. Push the commit with your project content to this GitHub repository:

      Perform the command:git push -u origin main

      This tells your local git to push the main branch to the remote repository. The -u option is used because the branch main did not yet exist on the remote repository.

    5. When prompted, enter your GitHub username and the personal access token, that you have created previously.

      Note
      The prompt appears in the upper middle of the SAP Business Application Studio, not in the terminal tab that you have used until now.

Result

You have connected your CAP project with your public GitHub repository using git commands4.

Reference Links: Creating and Connecting a GitHub Repository

For your convenience, this section contains the external references in this lesson.

If links are used multiple times within the text, only the first location is mentioned in the reference table.

Reference Links: GitHub

Ref#SectionContext text fragmentBreif descriptionLink
1Create and Connect a GitHub Repositorythe steps described in Creating a personal access tokenGitHub tokenhttps://github.com/
2Create a Personal Access Token for GitHubyou will create a public GitHub repositoryProject GitHubhttps://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token
3Connect Your GitHub Repository with Your CAP Projectopen your SAP BTP TrialSAP BTP trialhttps://cockpit.hanatrial.ondemand.com/
4Summarypublic GitHub repository using git commandsGit commandshttps://git-scm.com/docs

Save progress to your learning plan by logging in or creating an account