Skip to content

Commit

Permalink
chore: Use eldev-use-vc-repository instead of a submodule.
Browse files Browse the repository at this point in the history
  • Loading branch information
szermatt committed Dec 29, 2024
1 parent bdd2d53 commit 0c1fe1e
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 14 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ jobs:

- name: Check out the source code
uses: actions/checkout@v4
with:
submodules: true

- name: Install Sphinx
run: |
Expand Down
9 changes: 4 additions & 5 deletions Eldev
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,10 @@
'(:package tempel :version "0.8")
'(:package yasnippet :version "0.14.0"))

;; Install turtles test dependency as a git submodule, as it is not
;; yet stable enough to be treated as a package.
(eldev-add-extra-dependencies
'(test emacs) 'turtles)
(eldev-use-local-dependency "./deps/turtles")
(eldev-add-extra-dependencies '(test emacs) 'turtles)
(eldev-use-vc-repository
'turtles :github "szermatt/turtles"
:commit "e2b0de8d6684e9f4d75282f5836e110cc7736c31")

;; Exclude work and build files so Eldev doctor ignores them.
(setf eldev-standard-excludes
Expand Down
1 change: 0 additions & 1 deletion deps/turtles
Submodule turtles deleted from e2b0de
5 changes: 2 additions & 3 deletions docs/source/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,8 @@ To contribute code to the project, open a `Pull Request`_.
Before you do that, please make sure the any new features is covered
by tests and that the tests pass.

To run the tests, first checkout the test dependencies with
:command:`git submodule update --init--recursive`, install and setup
`eldev`_, then run :command:`eldev test`.
To run the tests, install and setup `eldev`_, then run :command:`eldev
test`.

Tests can also be run from inside of Emacs, using `M-x
ert-run-tests-interactively` but when you do so, be aware that there
Expand Down
5 changes: 2 additions & 3 deletions mistty.texi
Original file line number Diff line number Diff line change
Expand Up @@ -2037,9 +2037,8 @@ To contribute code to the project, open a Pull Request@footnote{https://github.c
Before you do that, please make sure the any new features is covered
by tests and that the tests pass.

To run the tests, first checkout the test dependencies with
@code{git submodule update --init--recursive}, install and setup
eldev@footnote{https://github.com/emacs-eldev/eldev}, then run @code{eldev test}.
To run the tests, install and setup eldev@footnote{https://github.com/emacs-eldev/eldev}, then run @code{eldev
test}.

Tests can also be run from inside of Emacs, using @cite{M-x ert-run-tests-interactively} but when you do so, be aware that there
might be unexpected interaction with your Emacs configurations. The
Expand Down

0 comments on commit 0c1fe1e

Please sign in to comment.