branch: elpa/bash-completion commit e75de2a86a58844d8693660694c32e5b5328325a Author: Stephane Zermatten <szerm...@gmx.net> Commit: Stephane Zermatten <szerm...@gmx.net>
Switch from Cask to Eldev to build and run tests. This change documents using Eldev instead of Cask to run the tests and remove Cask and its associated Makefile. --- .gitignore | 2 -- CONTRIBUTING.md | 9 ++++----- Cask | 9 --------- Makefile | 42 ------------------------------------------ 4 files changed, 4 insertions(+), 58 deletions(-) diff --git a/.gitignore b/.gitignore index 56928626e6..51e7bb6fb2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,5 @@ *.elc README.html -.cask -test/.set-bash-prog.el ert-profile bash-completion-autoloads.el .eldev/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70312c5287..c040d8bea5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,16 +32,15 @@ To contribute code to the project, open a [pull request][pulls]. Before you do that, please make sure the any new features is covered by tests and that the tests pass. -To run the tests, install and setup -[cask], then run them with +To run the tests, install [eldev], and run the tests with: ```bash -make test +eldev test ``` Tests can also be run from inside Emacs, using `M-x ert-run-tests-interactively` but when you do so, be aware that there might be unexpected interaction with your Emacs -configurations; Tests passing when run from Cask is what matters. +configurations; Tests passing when run from Eldev is what matters. After you've sent your pull request, please check the result of [GitHub actions][actions] running tests on your pull request. GitHub @@ -54,7 +53,7 @@ For larger features, it's a good idea to first open an thinking about working on it. This gives an opportunity to discuss the new feature and its possible implementations. -[cask]: https://github.com/szermatt/emacs-bash-completion/issues +[eldev]: https://emacs-eldev.github.io/eldev/ [issues]: https://github.com/szermatt/emacs-bash-completion/issues [actions]: https://github.com/szermatt/emacs-bash-completion/actions [pulls]: https://github.com/szermatt/emacs-bash-completion/pulls diff --git a/Cask b/Cask deleted file mode 100644 index 739e198d5b..0000000000 --- a/Cask +++ /dev/null @@ -1,9 +0,0 @@ -(source gnu) -(source melpa) - -(package-file "bash-completion.el") - -(files "bash-completion.el") - -(development - (depends-on "ert-runner")) diff --git a/Makefile b/Makefile deleted file mode 100644 index 1734e5290f..0000000000 --- a/Makefile +++ /dev/null @@ -1,42 +0,0 @@ -CASK ?= cask -EMACS ?= emacs -BASH ?= bash -BASH_COMPLETION_RC ?= /etc/bash_completion - -setup_bash=test/.set-bash-prog.el - -all: test -.PHONY: all - -test: clean-elc - ${MAKE} ert - ${MAKE} compile - ${MAKE} ert - ${MAKE} clean-elc -.PHONY: test - -unit: - ${CASK} exec ert-runner -L . test/bash-completion-test.el -.PHONY: unit - -integration: setup_bash - ${CASK} exec ert-runner -L . -l $(setup_bash) -p integration test/bash-completion-integration-test.el -.PHONY: integration - -ert: setup_bash - ${CASK} exec ert-runner -L . -l $(setup_bash) -.PHONY: ert - -compile: - ${CASK} build -.PHONY: compile - -clean-elc: - ${CASK} clean-elc -.PHONY: clean-elc - -setup_bash: - @echo '(setq bash-completion-prog "${BASH}")' >$(setup_bash) - @echo '(setq bash-completion_test-setup-completion "${BASH_COMPLETION_RC}")' >>$(setup_bash) -.PHONY: setup_bash -