Introduction

SAP Business Application Studio  has recently been released to customers on Azure, AWS, Alibaba-Cloud.

Read more about SAP Business Application Studio hear  : a central blog with links to useful information or  Blog post

Hands-on tutorials /How to guides  : https://developers.sap.com/tutorial-navigator.html?tag=products:technology-platform/sap-business-application-studio

Tutorials

 SAP Tutorials for Developers

https://developers.sap.com/group.appstudio-fiori.html

Create an Empty SAPUI5 Project

Create an SAP Fiori App Using SAP Business Application Studio

Deploy Your Business Application to Cloud Foundry

Build and Deploy Your SAP Fiori App to SAP Business Technology Platform

Develop Full-Stack App Using Low-Code Capabilities of SAP Business Application Studio

Debug Your SAPUI5 App with SAP Business Application Studio

 

You can build business applications, OData Services/ REST API’s, Fiori Elements, SAP UI5 Freestyle applications, SAP S/4HANA extensions, Mobile services, Node JS app ,Java app ,ABAP development  for SAP multi-cloud environment (CF), Azure

You can refer my previous blogpost for overview of next generation of WebIDE from “SAP Business Application Studio “, I will try to make sure that this blogpost  act as central blog which will have all required material ,links to useful information,  migration guides & help guides as references written from various experts which help developers

instead of referring many blog posts about “SAP Business Application Studio”

For how to develop applications using “SAP Business Application Studio “ tutorials please refer https://developers.sap.com/tutorial-navigator.html?tag=products:technology-platform/sap-business-application-studio

In this blog post I will cover Git scenarios

Using SAP Business Application Studio, you can connect to all public git services, such as GitHub, GitLab, and GitBucket i.e You can connect to whichever repository you want using the supported authentication methods.

See Connect to Your Git Source Control System for more information

If you have requirement/questions “Working with Github in SAP Business Application Studio” or “Using SAP Business Application Studio with Github “ ,"How to setup Git" ,"How do i push or clone from Git"  then this blogpost may help you . I will share my knowledge on this topic as Initially I also struggled to get it done as “SAP Business Application Studio” is new to most of us .

Question1 ) 
Do I need to install git or any thing to interact with Github from in SAP Business Application Studio ?

Answer) No need to install git or Github desktop or any tools

Because “SAP Business Application studio comes with predefined set of development environments, auto tools, plugins to support Github”

Question2) 
What are Pre-requisites or Knowledge?

Answer) 1. Any Git account on code hosting platform for version control and collaboration i.e your organisation/corporate Github , github or GitLab, bitbucket
Example: In this blog post I tried https://github.com/
2.Just a browser to access SAP Business Application studio


You can get trail account as described in this blog post SAP Business Application Studio

Tip: If you are familiar with git commands then your job will 
be easy Because “SAP Business Application Studio” allows 
you to run Git commands from terminal how we generally 
execute in GitBash or Visual Studio code terminal . 
Reference: https://git-scm.com/docs

What you’ll learn

1) Setup your username, email in SAP Business Application Studio
2) Password for your Github account
3) Connect to Your Corporate Git System 
4) How to cache Username & Password (Token) in SAP Business Application Studio
5) Create a new repository on GitHub
6) Clone existing repository in SAP Business Application Studio from GitHub Url
7) How to Push your code to GitHub in SAP Business Application Studio
8) How to Clone a Specific Branch from Git
9) Fetch latest code from specific branch
10) Switch to a specific branch
11) Create new Application in SAP Business Application Studio and Push application to GitHub
12) How to Push an Existing Project or New Project to Existing GitHub Repository 
13) Other Git Operations like Pull Request (PR)
14) Troubleshooting
15) UI
16) Download ,import ,export Project code, files from SAP Business Application Studio

1) Setup your username, email in SAP Business Application Studio

• Open Terminal in SAP Business Application Studio, From Terminal Menu in Menu Bar
• Run below command from terminal either from Projects directory or Change the current working directory to your local project.

Terminal –> New terminal –> cd projects –> cd yourprojectrootfolder

git config —-global user.email “xxxxxxxx@users.noreply.github.com”

git config —-global user.name “Showkath”

 

1.1) How do I know my email id in Github?

Go to Settings –> emails  Section –>  Make a note of public profile email

Please make sure that you enter valid email id from either Github or your corporate email id registered in Github

for example, john.test@sap.com otherwise your code push fails

Instead of entering your private email address you can enter public profile email address

 

Note : If you enter your private email address & but u enabled “Keep my email address private”

Then you may face error “GH007 Your push would publish a private email address” to fix this error

you can enter public profile email address from your Github account

1.2) How to know the git username ,email ,github url saved during configuration  in SAP Business Application Studio?

In terminal of  SAP Business Application Studio run below git commands

The command “git config –list” will list the settings, repository  details

There you should also find user.name and user.email.

To know the username, type:    git config user.name

To know the email, type: git config user.email

 

2) Password for your Github account

 

As of now SAP Business Application studio support  Personal access tokens instead of passwords

To use git in a SAP Business Application Studio (BAS) you should create an access token on github.xxxx –> (settings -> developer settings -> personal access tokens) with the scope “repo”

 

Personal access tokens (PATs) are an alternative to using passwords for authentication to GitHub when using the GitHub API or the command line i.e Personal access tokens function like ordinary OAuth access tokens. They can be used instead of a password for Git over HTTPS

Personal access tokens can only be used for HTTPS Git operations. If your repository uses an SSH remote URL, you will need to switch the remote from SSH to HTTPS

You should create a personal access token to use in place of a password with the Github UI or with the command line

To create a token, follow the instructions described in the GitHub documentation

Reference

https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token

 

How to create personal access token

1)In the upper-right corner of Github page, click your profile photo, then click Settings.

2)Click Developer settings

3)Click Personal access tokens

4)Click Generate new token

5)Give your token a descriptive name (What’s this token for?)

6) Select the scopes “repo” , or permissions, you’d like to grant this token. To use your token to access repositories from the command line, select repo.

7)Using a token on the command line

For example, on the command line you would enter the following:

$ git clone https://github.com/username/repo.git

Username: your_username

Password: your_token

 

Screenshots

Go to Github or your corporate GitHub account

 

 

 

 

 

Make Sure to copy your new personal access token /oAuth token to notepad or any secure place ,latter you will use in SAP Business Application Studio Terminal ,Otherwise you can also regenerate new one if you forgot from github account .

 

 

 

Note : For corporate GitHub you can get  oAuth token from example : https://github.xxxxx.corp/settings/tokens

3) Connect to Your Corporate Git System

Below configuration is not for opensource github or gitlab .

It is for your actual corporate/enterprise Github system.

See Connect to Your Corporate Git Repository  for more information on using a destination with Cloud Connector as your GIT on-premise setup

Usually this configuration will be  be done by your organization cloud admin for SCP Cloud Foundry sub-account level & it is one time setup/activity i.e every developer no need to perform this configuration. So this connectivity should be set once for each new consumer account. Once it is set, all developers working in this consumer account can enjoy from it without an additional setup

For example:

If you would like to connect to  github.xxxx.  with SAP Business Application Studio from public internet or SCP Trail account you need to follow Connect to your Corporate Git System as the github.xxxx can’t be reached from the public internet.

• github.xxxx.  on premise requires configuring cloud connector in the account  and adding a dedicated destination.

• To configure cloud connector please refer to the official documentation:

https://help.sap.com/viewer/9d1db9835307451daa8c930fbd9ab264/Cloud/en-US/d54ddfc1bc4f45b19dabfa0950799685.html

 

Just for your reference cloud connector & BTP Destination looks like as below

 

 

Note :

 

#1) if you don’t configure & clone your corporate Github Url in SAP Business Application Studio then you will get

500 error ,unable to access .The requested URL returned error : 500

 

#2) If you get error fatal: unable to access  github ‘https://github.xxxx.corp/xxxx/xxxx.git/’: Received HTTP code 502 from proxy after CONNECT

Then try configure proxy or unset

Then i tried below proxy commands from terminal

git config –global http.proxy “http://proxy:xxxxyourcorportateport”

or

git config –global –unset https.proxy

git clone https://github.xxx/xxxxxx/xxxxx.git

4) How to Cache Username & Password (Token) in SAP Business Application Studio

You no need to enter login credentials, every time you commit or push your code to github repository

As SAP Business Application studio supports git commands you can user credential helper to store your credentials which is similar how your credentials stored in Windows machine à credential manager in the same way application studio cache your credential instead of retype username & password .

I think you have below  options

 

SAP Business Application Studio recently released new feature that while you are cloning project  ,it will ask  to enter email & personal access token . Then you can choose below option to save your credentials ( email , personal access token  in your workspace

 

 

 

Below Previous approaches are obsolete i.e with above new feature of saving credentials you no need to follow below approaches

1) .netrc  in SAP Business Application Studio

2) …or    Git Credential helper

 

Option1:.netrc  in SAP Business Application Studio

To save your Git personal access token in your Dev space

You just need to create a .netrc file in the $HOME directory & add below syntax .You can create this  “.netrc” file either using UI or commands

Steps for UI Approach

1. In Application Studio click on File Menu & Open WorkSpace -> Select “User” workspace & click on Open

       2. Right click & select create new file(or press Alt N from keyboard )  in root directory  USER

          Enter file name as  .netrc

      3.Add the following content as per your github.corp

machine <git_host>
login <user_id>
password <user_github personal access token>

Details

machine name: As your corporate Git hub url without protocol “https:/”

login: As your corporate  Github Emailid

password: Your User organization Github personal access token

To know your token Refer above section 2) Password for your Github account in this blog post

For example 

machine github.com
login john@myorg.com
password 825270ffffe74d9f988a0f0066ad59f0

 

Reference :

https://help.sap.com/doc/47f5ed8a96a04b619d3c1724922b4151/Cloud/en-US/Wing_public.pdf

 

Option2 :Git Credential helper

 

Enter below commands once you login successfully when you push first time  from Terminal

git config credential.helper cache –timeout=3600000

git config credential.helper store

Hear : 3600000 milliseconds equals to 60  minutes

To erase credentials use below command i.e to disable this cached username/password for your current local git folder, simply enter

 

git config credential.helper “”

 

5) Create a new repository on GitHub

A repository is usually used to organize a single project. Repositories can contain folders and files, images, videos, spreadsheets, and data sets – anything your project needs.

To create a new repository

1. Go to https://github.com/ or your corporate Github account
2. In the upper right corner, next to your avatar or identicon, click  and then select New repository.
3. Name your repository or project name for example :  helloSAP
4. Write a short description

 

 

Note : If you select Private type “You can choose who can see and commit to this repository.”

You can learn more about Github. hear https://guides.github.com/

Below are git commands you can execute in “SAP Business Application Studio” à Terminal

Instruction generated in Github

6) Clone existing repository in SAP Business Application Studio from GitHub Url.

 

• Copy Your application URL

You have 3 options to clone existing repository

1)via Welcome page

2) …or. via Command Palette

3) …or. Execute Git commands from Terminal

 

• In Welcome page “Click clone from Git” & enter Git your project Url
• Example : https://github.com/Showkath/helloSAP.git

 

… or  alternately you can also use Command Palette

Go to  “View Menu->  Select Find Commandà enter “git clone”

..or Alternately you can use “git clone your-git project url”     from SAP Business Application Studio terminal

 

• Once Project cloned you can Open Workspace & select Project

 

 

 

7) How to Push your code to GitHub in SAP Business Application Studio

Just for simplicity i have added one file & then pushed file to git hub repository cloned above https://github.com/Showkath/helloSAP.git

 

 

Don’t git push straight to master. Branch it out!
Always Pull Before a Push. Doing so will ensure that your local copy is in sync with the remote repository.
Remember, other team members have been pushing to the github remote and if you push before syncing up,
you could end up with multiple heads or merge conflicts when you push. Before you try to push code out to the repository,
you should always pull all the current changes from the remote repository to your local machine.

 

To create a branch, run git branch -b <branch_name>. The command git branch -a lists all the available branches, and you can navigate among them using git checkout <branch_name>.

A cool trick is to use git checkout – to switch back to the previous branch.

 

You can also create branch  in github  or via  git commands & push you code to that branch

As said best practice to use  always pull before a push

with below command

git fetch

or

git fetch -all

 

Refer Miscellaneous Section for more details in this blog & Please explore more about git fetch , git pull, git stash over web or git commands

 

---

You need to execute below 4 commands from terminal to push your changes

 

git status

git add  .

git commit -m “type your sample commit message about commit hear”

git push -u origin dev

Hear dev is one of branch created in github in repository.

Then enter Username  & Personal access token again if you have not cached or password expired as explained in above sections.

Tip: If you are familiar with git commands then your job will 
be easy Because “SAP Business Application Studio” allows 
you to run Git commands from terminal how we generally 
execute in GitBash or Visual Studio code terminal . 
Reference: https://git-scm.com/docs

8) How to Clone a Specific Branch from Git

When u run below command ,if this repository contains many branches , this fetch all branches in github repository and you can easily switch between each to see each branch with below commands

 

git clone <repository url?

git clone https://github.com/SAP/openui5-sample-app.git

git branch <branchname>

 

Example :  git branch –karma-test

 

How to Clone a Specific Branch

 

Now let’s clone a specific branch from Github repository. There are two ways to clone a specific branch. There are two options

option1 :

 

git clone —-branch <branchname> <remote-repo-url>

 

Example : git clone —-branch release-0.23 https://github.com/SAP/ui5-webcomponents.git

 

This automatically configures release-0.23 as the local branch but still tracks other branches.

 

or

option2 :

 

git clone —-branch <branchname> —-single-branch <remote-repo-url>

 

Example  : git clone —-branch release-0.23 —-single-branch https://github.com/SAP/ui5-webcomponents.git

 

This performs the same action as option1 , It allows you to only fetch files from the specified branch without fetching other branches.

 

Note : Instead of —-branch you can also use short form  -b is an alias for –branch

git clone –b <branchname> <remote-repo-url>

 

Tip: If you are familiar with git commands then your job will 
be easy Because “SAP Business Application Studio” allows 
you to run Git commands from terminal how we generally 
execute in GitBash or Visual Studio code terminal . 
Reference: https://git-scm.com/docs

 

9) Fetch latest code from specific branch

To Pull latest source code from specific branch

Syntax: git pull origin <branch-name>

First make sure you are in branch that you don’t want to pull.
For example if you have master and development branch, and you are trying to pull develop branch then stay in master branch.

git checkout master
git pull origin development

 

10) Switch to a specific branch

You can use git checkout or switch command

When your team working on a project, you are team members probably managing many different branches in your repository. As the number of branches grow, developers may need to work on different tasks in parallel, so you may need to switch branches very frequently.

Before creating/switch view all the branches that exist in the repo.

 

#1) git branch

Output:

*master
development
feature1

#2)

You can use git switch or checkout . Currently switch  not supported hear . So please try git checkout command

 

SYNTAX: git checkout <branch-name>

or

SYNTAX: git switch <branch-name>

or

You can also clone in other folder  git clone –branch branchname https://github.xxx.xx.xxxxx.git

Let’s suppose there is an existing branch called develop and we want to switch from master to develop branch. To do that execute:

git switch development

To switchback to master

git switch master

Let’s suppose if you would like to create a new branch which doesn’t exist and also at the same time we want to switch to it. For that

git switch -c new-branch-name

or

git branch new-branch-name
git switch new-branch-name

——–

To switch to a remote branch

In order to switch to a remote branch, make sure to execute “git fetch” first.
You can then switch to it by executing “git checkout” with the “-t” option and the name of the branch or git switch

git fetch
git checkout -t <remote_name>/<branch_name>
or
git switch -c <branch> –track <remote>/<branch>

Reference: https://git-scm.com/docs/git-switch

 

11) Create New Application in SAP Business Application Studio and Push to GitHub

 

Let’s assume you already created applications using Project templates in SAP Business Application Studio with the help of below tutorials

Question ) What Kind of applications I can build using SAP Business Application Studio?

https://developers.sap.com/tutorial-navigator.html?tag=products:technology-platform/sap-business-application-studio

Or you may have followed develop Your First SAPUI5 Web App with SAP Business

 

 

Lets say i have given Project name as “helloSAPUI5CF”

 

 

I am not covering all steps hear to how to create project , please follow awesome tutorials /how to guides available from SAP Developers Community

 

# Develop Your First SAPUI5 Web App with SAP Business Application Studio

https://developers.sap.com/group.cp-ui5-first-app.html

# Create a Web Front End with SAPUI5

https://developers.sap.com/group.cp-frontend-ui5-1.html

 

# Deploy Your First SAPUI5 App to Cloud Foundry

https://developers.sap.com/tutorials/appstudio-sapui5-create.html

 

# Create an SAP Fiori App Using SAP Business Application Studio

https://developers.sap.com/tutorials/appstudio-fioriapps-create.html

 

# How to develop Fiori App in SAP Business Application Studio

https://www.saplearners.com/how-to-develop-fiori-app-in-sap-business-application-studio/

# All Tutorials/Exercises :

https://developers.sap.com/tutorial-navigator.html?tag=products:technology-platform/sap-business-application-studio

————————————————————————————————————————————–

Once project is ready now you would like to push project to Github ,please follow below steps

Please read above sections if you have missed before proceeding further

1. Setup your username, email in SAP Business Application Studio.
2. Know your Password for your git hub

Then You have two options “Create a new repository on GitHub” or do everything from git commands git init

 

I follow this easy approach I.e I will create empty repository with same name I have given for project

for example : helloSAPUI5CF 

• Please follow “Create a new repository on GitHub” in above section in github or your corporate github.mycompany.com
• 
• Execute below commands from your project root directory  in SAP Business Application Studio Terminal
• cd projects
• cd helloSAPUI5CF 
• git init
• git add .
• git commit -m “my SAPUI5 CF first commit”
• git branch -M main
• git remote add origin https://github.com/Showkath/helloSAPUI5CF.git
• git push -u origin main

Note : Here main is your branch name

 

12 ) How to Push an Existing Project or New Project to Existing GitHub Repository

 

Lets say you need to push new project which you have created in SAP Business Application Studio to  old git repository  which is already exist in Github i.e if your project in BAS & GitHub both are independent then execute below commands

 

• git init
• git add -A
• git commit -m “my first commit comments’
• git remote add origin https://xxxxxx.git
• git push -u origin main

Note : Here please replace above with your github http url & main is your git repo existing branch name

Just additional details about commands  :

git add -A stages all changes
git add . stages new files and modifications, without deletions (on the current directory and its subdirectories).
git add -u stages modifications and deletions, without new files
git add -A is equivalent to git add .; git add -u.

You can check your git remote to see where it is pointing to by executing below command

git remote -v

13) Other Git Operations

For more details refer https://guides.github.com/

Note : You can run normal cd commands from SAP Business Application terminal to navigate to folders

cd..  = to navigate to one step back

pwd  = which gives present working directory or location

Tip: If you are familiar with git commands then your job will 
be easy Because “SAP Business Application Studio” allows 
you to run Git commands from terminal how we generally 
execute in GitBash or Visual Studio code terminal . 
Reference: https://git-scm.com/docs

Here are few useful git commands

 

Miscellaneous Section

Git pull = Git fetch + additional action(s),typically a Git merge
Every time you run git pull with uncommitted changes could get you into trouble

git fetch
git merge origin/$CURRENT_BRANCH
merge the changes from the remote repository that are not already present in your local checked out branch

Git fetch is a safer because it pulls in all the commits from your Github remote
without actually making any local changes to your work in your local branch
One thing to note is that by default, git fetch will only bring you changes from the current branch.
To get all the changes from all the branches, use git fetch –all.
And if you’d like to clean up some of the branches that no longer exist in the remote repository, git fetch –all –prune will do the cleaning up!

When your uncommitted changes are significant to you & you very much care about the Local Changes
git stash : To save your un-committed changes in a “stash”
git stash list:To list your saved stashes
git stash apply:apply stash to working tree in current branch
git stash apply stash@{x}
Example: git stash apply stash@{2}:if you will have many stashes you can choose what stash will apply — in this case we apply stash 2
git stash branch: To create a new branch to apply your stashed changes to.
For example
git stash branch master_stash_newBranch stash@{1}

Git is powerful. Please explore more about git over web or git commands

14) Troubleshooting

Find here common solutions to frequently occurring issues.

1. Git Pull Error: The following untracked working tree files would be overwritten by merge:
   xxxxxx.xxxx
   Please move or remove them before you merge.
   Aborting
   Soluition: Error is due to your local changes to repository that is, your modified files in your working directory .

One Solution could be clear tracked files by using below command

            git clean -d -f      

then try git pull Before executing above clean  command ,if you need to take a back of your files, source code & stage them using git stash

•  https://git-scm.com/book/en/v2/Git-Tools-Stashing-and-Cleaning
•  https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/stashing-changes#stashing-changes

2) Github : Merge Button is not enabled i.e Requests stuck in “Checking ability to merge automatically” ,Never disappeared to Merge

On all of the pull request (PR) merge requests  the “Checking ability to merge automatically” icon appeared . In most instances, after a few minutes, and after refreshing the page, it finally went away. It appeared to go away after the build and pipelines had been completed but if it never disappeared below solution may help you

Execute below commands from Terminal or Gitbash

lets say your reviewer would like to review & merge “YourBranchName” to master but ” Merge” but not enabled

Step1 :

git fetch origin
git checkout -b “YourBranchName” “origin/YourBranchName”
git merge “master”

Step 2 :

git checkout “master”
git merge –no-ff “YourBranchName”
git push origin “master”

After executing above commands  “YourBranchName” will be merged to master, you can also verify in Github

15) UI

SAP Business Application Studio also supports UI for various Git operations

 

 

16) Download ,import ,export Project code, files from SAP Business Application Studio

 

1. You can download entire project as a tar from one Dev Space of BAS to import into other Dev Space

 

       2. You can also download selected files or entire project to your local machine

3. You can upload multiple files from your local machine to your space project desired folders in SAP Business Application Studio

Screenshots 

 

Just right click with mouse on project or file you will get context menu in SAP Business Application Studio 

You can upload multiple files from your local machine to your space project desired folders in SAP Business Application Studio

Select files from you local machine i,e from your system

 

Upload ZIP Archive  / Compress file & extract in SAP Business Application studio

 

SAP Business Application Studio will provide different options to resolve any Usecase. If you would like to upload folder (without using Git) one solution is

 

1. Compress ZIP folder
2. Create new folder in SAP Business Application studio with same name as ZIP file name
3. Upload ZIP Archive file to desired folder
4. Open Terminal in SAP Business Application Studio
5. Navigate to newly created folder or where you would like to extract . You can use “cd (“change directory”)” commands from terminal
6. Then extract folder / unzip in SAP Business Application Studio terminal with below command.

 

unzip yourfoldername.zip

 

Screenshots for your reference

 

 

 

 

 

Open Terminal in SAP Business Application Studio

 

Navigate to newly created folder or where you would like to extract . You can execute  “cd (“change directory”)” commands from terminal

Then extract folder / unzip in SAP Business Application Studio terminal with below command

Later you can delete ZIP file (Right Click on ZIP file & choose Delete)

 

Tip : How to delete project from SAP Business Application studio ?

Either you can right click on Project folder & choose Delete from context Menu or you can use rm commands

Option1) Delete option using Context Menu

If you have single project opened as workspace you don’t get “Delete” option. For this you need to open workspace & choose Projects

Then Rightclick on Project which you would like to delete , you will get menu & choose Delete

 

Hope this blog post helps