https://github.com/guillaumefalourd/ssh-to-https

Github Action to configure git to use HTTPS authentication instead of SSH
https://github.com/guillaumefalourd/ssh-to-https

all-os-supported config git github-action global

Last synced: 2 days ago
JSON representation

Github Action to configure git to use HTTPS authentication instead of SSH

• Host: GitHub
• URL: https://github.com/guillaumefalourd/ssh-to-https
• Owner: GuillaumeFalourd
• License: apache-2.0
• Created: 2021-10-20T20:22:59.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-20T21:37:50.000Z (about 3 years ago)
• Last Synced: 2024-10-14T09:21:27.239Z (about 1 month ago)
• Topics: all-os-supported, config, git, github-action, global
• Homepage:
• Size: 22.5 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SSH-to-HTTPS

[![Action test on Ubuntu](https://github.com/GuillaumeFalourd/SSH-to-HTTPS/actions/workflows/ubuntu-test-action.yml/badge.svg)](https://github.com/GuillaumeFalourd/SSH-to-HTTPS/actions/workflows/ubuntu-test-action.yml) [![Action test on MacOS](https://github.com/GuillaumeFalourd/SSH-to-HTTPS/actions/workflows/macos-test-action.yml/badge.svg)](https://github.com/GuillaumeFalourd/SSH-to-HTTPS/actions/workflows/macos-test-action.yml) [![Action test on Windows](https://github.com/GuillaumeFalourd/SSH-to-HTTPS/actions/workflows/windows-test-action.yml/badge.svg)](https://github.com/GuillaumeFalourd/SSH-to-HTTPS/actions/workflows/windows-test-action.yml)

Github Action to reconfigure git to use HTTPS authentication instead of SSH (which is used by _default_ in the runner configuration).

_Kudos: This action implementation is based [on this comment](https://github.com/actions/setup-node/issues/214#issuecomment-810829250) on the [actions/setup-node](https://github.com/actions/setup-node)._

## 📚 Usage

### Requirements

⚠️    The [`actions/checkout`](https://github.com/marketplace/actions/checkout) is mandatory to use this action, with `persist-credentials: false`.

### Action inputs

Field | Mandatory | Observation

------------ | ------------  | -------------

**github_token** | NO | [How to create a PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)

### Without Github PAT

```yaml

      - name: Checkout

        uses: actions/[email protected]

        with:

          persist-credentials: false

      - name: Reconfigure git to use HTTPS authentication

        uses: GuillaumeFalourd/SSH-to-HTTPS@v1

```

### With Github PAT

```yaml

      - name: Checkout

        uses: actions/[email protected]

        with:

          persist-credentials: false

      - name: Reconfigure git to use HTTPS authentication

        uses: GuillaumeFalourd/SSH-to-HTTPS@v1

        with:

          github_token: ${{ secrets.ACCESS_TOKEN }}

```

_Note: You can use the default `${{ secrets.GITHUB_TOKEN }}` or your PAT with `${{ secrets.ACCESS_TOKEN }}`._

## Eventual security concerns

There is no difference in terms of transport security, HTTPS and SSH rely on similar underlying crypto.

Persisting your credentials by adding your [secret Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to the global git config does have security implications, but it's the default behavior of the [checkout action](https://github.com/actions/checkout) already (using `persist-credentials: true`) so no security is _"lost"_.

_If you don't want the PAT hanging around, run some form of [post-job cleanup](https://github.com/actions/checkout/blob/25a956c84d5dd820d28caab9f86b8d183aeeff3d/src/main.ts#L31)._

## 🤝 Contributing

☞ [Guidelines](https://github.com/GuillaumeFalourd/SSH-to-HTTPS/blob/main/CONTRIBUTING.md)

## 🏅 Licensed

☞ This repository uses the [Apache License 2.0](https://github.com/GuillaumeFalourd/SSH-to-HTTPS/blob/main/LICENSE)