https://github.com/purcell/setup-emacs

Github action which installs a given Emacs version
https://github.com/purcell/setup-emacs

Last synced: 4 days ago
JSON representation

Github action which installs a given Emacs version

• Host: GitHub
• URL: https://github.com/purcell/setup-emacs
• Owner: purcell
• License: mit
• Created: 2019-10-04T23:58:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-07T07:25:37.000Z (3 months ago)
• Last Synced: 2025-01-11T04:06:57.746Z (11 days ago)
• Language: Shell
• Homepage:
• Size: 181 KB
• Stars: 141
• Watchers: 6
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/purcell/setup-emacs/actions/workflows/test.yml/badge.svg)](https://github.com/purcell/setup-emacs/actions/workflows/test.yml)



# A Github Action that installs a specific emacs version

Uses [nix-emacs-ci](https://github.com/purcell/nix-emacs-ci) to provide binaries for a number of different Emacs versions.

Since that project uses Nix, Nix will be installed automatically if

necessary.

Note also that only Linux and MacOS are supported, since Nix is not

available on Windows.

Check out [examples of using this Action in the wild in 1500+ repositories](https://github.com/search?q=purcell%2Fsetup-emacs+++path%3A.github%2Fworkflows%2F*.yml&type=code).

See the [actions tab](https://github.com/purcell/setup-emacs/actions) for runs of this action! :rocket:

## Usage:

```yaml

uses: purcell/setup-emacs@master

with:

  version: 24.5

  ```

The `emacs` executable on the path will then be the requested

version. For a list of available versions, please see the

[nix-emacs-ci](https://github.com/purcell/nix-emacs-ci) project.

For an example of real-life usage, see the [Actions config for `package-lint`](https://github.com/purcell/package-lint/blob/master/.github/workflows/test.yml).



#### Note about compiling binary emacs modules

[Here's an example](https://github.com/xuchunyang/strptime.el) of a project which compiles binary modules against an Emacs installed with this method.

[💝 Support this project and my other Open Source work via Patreon](https://www.patreon.com/sanityinc)

[💼 LinkedIn profile](https://uk.linkedin.com/in/stevepurcell)

[✍ sanityinc.com](http://www.sanityinc.com/)