Table of Contents

• Description
• Usage
• Information
  • Donation
  • Community
  • Contribution
  • License
  • Author
  • Contributors

Description

setup-keg prepare Keg for your workflow.

• Fetch specified Keg in your workflow $HOME (such as /home/runner/.keg).
• Add /home/runner/.keg/bin to your workflow $PATH
• Initiarize Keg

Usage

Keg depends Emacs. You should setup, before use setup-keg.

This mechanism has a merit to be able to use specified version of Emacs.

setup-keg’s version accepts snapshot and version code. (see Keg release page)

And refference these action.yml

• setup-emacs/action.yml
• setup-keg/action.yml

Basic

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: purcell/setup-emacs@master
        with:
          version: '26.3'

      - uses: conao3/setup-keg@master
        with:
          version: 'snapshot'

      - name: Run tests
        run: make test

This example is testing your package in below environment.

• Emacs: 26.3
• Keg: snapshot (HEAD)

Matrix testing

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        emacs_version:
          - '26.1'
          - '26.2'
          - '26.3'
          - 'snapshot'
        keg_version:
          - 'snapshot'
    steps:
      - uses: actions/checkout@v1
      - uses: purcell/setup-emacs@master
        with:
          version: ${{ matrix.emacs_version }}

      - uses: conao3/setup-keg@master
        with:
          version: 'snapshot'

      - name: Run tests
        run: make test

This example is testing your package in below environment.

• Emacs: 26.1, 26.2, 26.3
• Keg: snapshot (HEAD)

Simplest

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: purcell/setup-emacs@master
        with:
          version: '26.3'
      - uses: conao3/setup-keg@master

      - name: Run tests
        run: make test

This example is testing your package in below environment.

• Emacs: 26.3
• Keg: snapshot (HEAD)

Information

Donation

I love OSS and I am dreaming of working on it as full-time job.

With your support, I will be able to spend more time at OSS!

Community

All feedback and suggestions are welcome!

You can use github issues, but you can also use Slack if you want a more casual conversation.

Contribution

Feel free to send PR!

License

MIT
Copyright (c) Naoya Yamashita - https://conao3.com
https://github.com/conao3/setup-keg/blob/master/LICENSE

Author

• Naoya Yamashita (conao3)

Contributors

• Not yet… Now send PR and add your name!!