netrc-creds

Install Credentials to your Github Actions netrc file. Useful for authenticating access to additional GitHub resources.

Usage

Pre-requisites

Create a workflow .yml file in your repositories .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.

Inputs

machine: Single entry mode machine.
login: Single entry mode login.
password: Single entry mode password.
creds: A JSON array of credential objects (machine, login, password). Optional. Github actions doesn't support strucutred input. womp.

Either a creds field, and/or a machine/login/password combo must be passed.

Outputs

None.

Example workflow

name: Example installing netrc creds

on: [push]

env:
  - login: l12s-bot

jobs:
  build:

    runs-on: ubuntu-latest

    strategy:
      matrix:
        node-version: [12.x]

    steps:
    - uses: actions/checkout@v1
    - name: Apply netrc creds with direct input
      uses: little-core-labs/netrc-creds@master
      with:
        machine: some.other.api.com
        login: person
        password: 1234qwer # store this in secrets
    - name: Apply netrc creds with direct input again
      uses: little-core-labs/netrc-creds@master
      with:
        machine: another.api.com
        login: person
        password: 1234qwer # store this in secrets
    - name: Apply netrc creds with a JSON block
      uses: little-core-labs/netrc-creds@v2.0.0
      with:
        creds: |
          [
            {
              "machine": "github.com",
              "login": "${{env.login}}",
              "password": "${{ secrets.GH_MACHINE_TOKEN }}"
            },
            {
              "machine": "api.github.com",
              "login": "${{env.login}}",
              "password": "${{ secrets.GH_MACHINE_TOKEN }}"
            }
          ]

FAQ

Can you offer a major version tag/branch alias? I want automatic updates!

Nope! This was always weird/bad pattern of github actions. Luckily github offers a solution for this. Create a .github/dependabot.yml with, at a minimum, the following config:

# Basic dependabot.yml file with
# minimum configuration for two package managers

version: 2
updates:
  # Enable version updates for npm
  # Enable updates to github actions
  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "daily"

License

The scripts and documentation in this project are released under the MIT License

little-core-labs / netrc-creds