1
0
mirror of https://github.com/vdm-io/github-user.git synced 2024-06-22 20:14:49 +00:00
Go to file
2021-07-13 21:40:59 +02:00
src Added github personal access token for CLI use. 2021-07-13 21:40:59 +02:00
.gitignore first commit 2021-04-30 22:20:48 +02:00
LICENSE Fixed the license to be version 2 as stated in the readme documentation. 2021-07-11 19:48:34 +02:00
README.md first commit 2021-04-30 22:20:48 +02:00

Github User Setup

We use this script to setup a github user on the Ubuntu systems in the Github Actions Workflows.

How To

You will need to setup a list of secrets in your account. You can do this per/repository or per/organization.

The github user email being used to build

  • GIT_EMAIL

The github username being used to build

  • GIT_USER

gpg -a --export-secret-keys >myprivatekeys.asc The whole key file text from the above myprivatekeys.asc This key must be linked to the github user being used

  • GPG_KEY

The name of the myprivatekeys.asc user

  • GPG_USER

A id_ed25519 ssh private key liked to the github user account

  • SSH_KEY

A id_ed25519.pub ssh public key liked to the github user account

  • SSH_PUB

All these secret values are needed to fully automate the setup to easy interact with gitHub.

Workflows

In your workflows action script you will need to add the following as an example:

jobs:
  build:
    runs-on: [ubuntu-20.04]
    steps:
      - name: Setup gitHub User Details
        env:
          GIT_USER: ${{ secrets.GIT_USER }}
          GIT_EMAIL: ${{ secrets.GIT_EMAIL }}
          GPG_USER: ${{ secrets.GPG_USER }}
          GPG_KEY: ${{ secrets.GPG_KEY }}
          SSH_KEY: ${{ secrets.SSH_KEY }}
          SSH_PUB: ${{ secrets.SSH_PUB }}
        run: |
          /bin/bash <(/bin/curl -s https://raw.githubusercontent.com/vdm-io/github-user/master/src/setup.sh) --gpg-key "$GPG_KEY" --gpg-user "$GPG_USER" --ssh-key "$SSH_KEY" --ssh-pub "$SSH_PUB" --git-user "$GIT_USER" --git-email "$GIT_EMAIL"          
      - name: Clone Master Repositry
        run: |
          /bin/git clone git@github.com:[org]/[repo].git [folder]          
      - name: Do your actions
        run: |
          cd [folder]
          /bin/bash ./src/run.sh          

Free Software

Llewellyn van der Merwe <github@vdm.io>
Copyright (C) 2019. All Rights Reserved
GNU/GPL Version 2 or later - http://www.gnu.org/licenses/gpl-2.0.html