2020-02-22 15:16:32 -08:00
|
|
|
#+TITLE: melpazoid
|
|
|
|
|
#+OPTIONS: toc:3 author:t creator:nil num:nil
|
|
|
|
|
#+AUTHOR: Chris Rayner
|
2020-02-22 11:48:06 -08:00
|
|
|
#+EMAIL: dchrisrayner@gmail.com
|
|
|
|
|
|
|
|
|
|
[[https://travis-ci.org/riscy/shx-for-emacs][https://travis-ci.org/riscy/melpazoid.svg?branch=master]]
|
|
|
|
|
|
2020-02-22 15:16:32 -08:00
|
|
|
/melpazoid/ is a bundle of scripts for testing Emacs packages, primarily
|
2020-02-22 17:18:00 -08:00
|
|
|
submissions to [[https://github.com/melpa/][MELPA]]. I've been using a variation of this script to help me
|
|
|
|
|
check MELPA [[https://github.com/melpa/melpa/pulls][pull requests]]. The ambition is CI checks that run in an "clean"
|
2020-02-22 15:16:32 -08:00
|
|
|
environment, either through CI or through a container on your local machine.
|
2020-02-22 11:48:06 -08:00
|
|
|
|
2020-02-22 17:18:00 -08:00
|
|
|
This is a work in progress -- feedback and pull requests are welcome (note my
|
|
|
|
|
current aim is to make this code simpler before I make it any more complicated).
|
|
|
|
|
|
|
|
|
|
The checks are a combination of:
|
|
|
|
|
1. byte-compile-file
|
|
|
|
|
2. [[https://www.emacswiki.org/emacs/CheckDoc][checkdoc]]
|
|
|
|
|
3. [[https://github.com/purcell/package-lint][package-lint]]
|
|
|
|
|
4. a license checker
|
|
|
|
|
5. some elisp checks
|
|
|
|
|
|
|
|
|
|
The first four are on the MELPA checklist, so you should try to get those right.
|
|
|
|
|
The license checker is currently very crude. The elisp checks are not foolproof,
|
|
|
|
|
sometimes opinionated, and may raise false positives.
|
|
|
|
|
|
2020-02-22 15:16:32 -08:00
|
|
|
* How to use melpazoid
|
2020-02-22 17:18:00 -08:00
|
|
|
You can fork it and let CI do the work, or use it locally.
|
|
|
|
|
** Fork it and let CI do the work
|
|
|
|
|
If you don't want to install this software or its dependencies, you are
|
|
|
|
|
encouraged to fork this repository and let CI do the work. You will need a
|
|
|
|
|
bit of experience with GitHub.
|
|
|
|
|
|
|
|
|
|
Then enable [[https://travis-ci.org][Travis-CI]] on your fork, or just open a pull request against this
|
|
|
|
|
repository (I won't merge it). The eventual build information will report any
|
|
|
|
|
issues.
|
|
|
|
|
|
|
|
|
|
Your fork will need to point to the Emacs package you want to build, which
|
|
|
|
|
can be done by modifying the ~.travis.yml~ file in one of the following ways.
|
|
|
|
|
*** Test a recipe before you even open a pull request to MELPA
|
|
|
|
|
Modify the ~env~ field and specify your clone url and your recipe:
|
|
|
|
|
#+begin_src yaml
|
|
|
|
|
env: >-
|
|
|
|
|
CLONE_URL='https://github.com/me/my-package-repo
|
|
|
|
|
RECIPE='(my-package :repo "me/my-package-repo" :fetcher github)'
|
|
|
|
|
#+end_src
|
|
|
|
|
*** Test a MELPA pull request you've already opened
|
|
|
|
|
Modify the ~env~ field and specify your open MELPA PR:
|
|
|
|
|
#+begin_src yaml
|
|
|
|
|
env: >-
|
|
|
|
|
MELPA_PR_URL='https://github.com/melpa/melpa/pulls/6713
|
|
|
|
|
#+end_src
|
|
|
|
|
** Use it locally
|
2020-02-22 15:16:32 -08:00
|
|
|
You will need Python ≥ 3.6 (and the ~requests~ package) and Docker. A
|
|
|
|
|
container will be built with (hopefully) all of your requirements installed.
|
|
|
|
|
The output scroll will report any discovered issues.
|
2020-02-22 11:48:06 -08:00
|
|
|
|
2020-02-22 15:16:32 -08:00
|
|
|
*** Test a MELPA PR
|
|
|
|
|
#+begin_src bash
|
|
|
|
|
MELPA_PR_URL='https://github.com/melpa/melpa/pull/6718' make
|
|
|
|
|
#+end_src
|
|
|
|
|
*** Test a remote package
|
|
|
|
|
#+begin_src bash
|
|
|
|
|
CLONE_URL='https://github.com/riscy/shx-for-emacs' \
|
|
|
|
|
RECIPE='(shx :repo "riscy/shx-for-emacs" :fetcher github)' \
|
|
|
|
|
make
|
|
|
|
|
#+end_src
|
|
|
|
|
*** Test a local package (work in progress)
|
|
|
|
|
#+begin_src bash
|
|
|
|
|
PKG_PATH='/path/to/package' \
|
|
|
|
|
PKG_NAME='package-name' \
|
|
|
|
|
make
|
|
|
|
|
#+end_src
|
