
This guide provides an example of how to set up an SAP workflow using GitHub Actions. For the official GitHub workflow configuration syntax and commands, please refer to the [official documentation](https://docs.github.com).

### Workflow overview

The GitHub Actions workflow automates the process of deploying and testing an SAP application. It is triggered upon a pull request to the main branch. The workflow consists of several jobs and steps:

1. **Create a new SAP instance** using the Nuve API and set up environment variables.
2. **Configure SAPCLI** with the necessary options for interacting with the SAP system.
3. **Test the connection** to the SAP system by executing an RFC_PING.
4. **Link the GitHub repository** to the SAP system.
5. **Switch to the branch under test** and pull the latest changes to the SAP system.
6. **Delete the created SAP instance** upon completion, regardless of the workflow's success.

Sensitive information, such as API tokens and passwords, is securely managed using GitHub secrets.

## Secrets and variables

**Secrets** store sensitive information like API tokens, passwords, or private keys that should not be exposed in logs or shared publicly. In the given workflow, secrets securely store sensitive data such as:

- `GH_TOKEN`
- `NUVE_API_TOKEN`
- `SAP_PASSWORD`

GitHub secrets are encrypted and can only be accessed by steps within the same repository, ensuring sensitive data remains secure.

**Variables** store non-sensitive data that can be exposed in logs or shared between steps within a job. Variables are useful for defining configuration values or reusing information throughout the workflow. In this case, variables store non-sensitive information such as:

- `ABAP_PACKAGE`
- `BACKUP_ID`
- `CLIENT`
- `GH_USERNAME`
- `PORT`
- `SAP_USER`

To configure GitHub Actions secrets and variables:

1. Navigate to the GitHub repository you want to configure secrets and variables for.
2. Click on the **Settings** tab located at the top of the page.
3. In the left sidebar menu, select **Secrets and variables**.
4. Under the Actions settings, click on **Secrets** or **Variables**, depending on what you want to add.
5. Follow the prompts to add your secrets and variables as needed.

## Example workflow configuration

```yaml
name: SAP Workflow

on:
  pull_request:
    branches:
      - main

jobs:
  sap_task:
    runs-on: [self-hosted]
    env:
      # GitHub-related variables
      REPO_NAME: ${{ github.repository }}
      GH_USERNAME: ${{ vars.GH_USERNAME }}
      GH_TOKEN: ${{ secrets.GH_TOKEN }}

      # Nuve API variables
      BACKUP_ID: ${{ vars.BACKUP_ID }}
      NUVE_API_TOKEN: ${{ secrets.NUVE_API_TOKEN }}

      # SAP-related variables
      ABAP_PACKAGE: ${{ vars.ABAP_PACKAGE }}

    steps:
    - name: Create Instance
      id: create-instance
      run: |
        nuve-api create --github_sha ${GITHUB_SHA:0:6} --backup_id ${BACKUP_ID} --nuve_api_token ${NUVE_API_TOKEN}

    - name: Set up environment variables
      env:
        # SAP-related variables
        HOST: ${{ env.ip_address }}
        CLIENT: ${{ vars.CLIENT }}
        PORT: ${{ vars.PORT }}
        SAP_USER: ${{ vars.SAP_USER }}
        SAP_PASSWORD: ${{ secrets.SAP_PASSWORD }}
      run: |
        echo "SAPCLI_OPTIONS=--user ${SAP_USER} --password ${SAP_PASSWORD} --ashost ${HOST} --client ${CLIENT} --port ${PORT} --no-ssl" >> $GITHUB_ENV

    - name: Set up SAPCLI configuration
      run: echo "SAPCLI_CONFIG=sapcli ${SAPCLI_OPTIONS}" >> $GITHUB_ENV

    - name: Execute RFC_PING
      run: ${SAPCLI_CONFIG} startrfc RFC_PING

    - name: Link repo
      run: |
        ${SAPCLI_CONFIG} startrfc -c bapi ZABAPGIT_API_RFC_LINK -S=GIT_REPO_URL:https://github.com/$REPO_NAME -S=GIT_USER:${GH_USERNAME} -S=GIT_PASSWORD:${GH_TOKEN} -S=ABAP_PACKAGE:${ABAP_PACKAGE} || true

    - name: Set and pull branch under test
      run: |
        ${SAPCLI_CONFIG} startrfc -c bapi ZABAPGIT_API_RFC_SWITCHBRANCH -S=ABAP_PACKAGE:${ABAP_PACKAGE} -S=GIT_USER:${GH_USERNAME} -S=GIT_PASSWORD:${GH_TOKEN} -S=BRANCH_NAME:${{ github.head_ref }}
        ${SAPCLI_CONFIG} startrfc -c bapi ZABAPGIT_API_RFC_PULL -S=ABAP_PACKAGE:${ABAP_PACKAGE} -S=GIT_USER:${GH_USERNAME} -S=GIT_PASSWORD:${GH_TOKEN}

    - name: Run ABAP Unit
      run: |
        ${SAPCLI_CONFIG} startrfc -c bapi ZFM_RUN_ABAP_UNIT -S=IM_OBJECT_NAME_V:${ABAP_PACKAGE}

    - name: Delete Instance (if exists)
      if: always()
      run: |
        instance_id=${{ env.instance_id }}
        if [ "$instance_id" ]; then
          nuve-api delete --instance_id ${instance_id} --nuve_api_token ${NUVE_API_TOKEN}
        fi
```

SAP workflow setup guide

Guide on setting up an SAP workflow using GitHub Actions, including secrets and variables management.

GitHub Actions workflow configuration file

Related support articles

Setup a GitHub runner

Running ABAP unit tests in GitHub Actions

Integrating transports in your workflow configuration