This is an automated email from the ASF dual-hosted git repository. sjanc pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/mynewt-newt.git
commit 4b59c7dfae97e988d86a40118d6200594d31d986 Author: Szymon Janc <[email protected]> AuthorDate: Thu Oct 15 19:18:29 2026 +0200 README: Describe how to run newt tests locally The "Writing Tests" section still pointed at Travis CI. Describe the Go tests instead: how to run them, what they need and where the test projects live. Also replace the badges of the removed dump and upgrade workflows with the unit test workflow badge. Assisted-by: Claude:claude-opus-5-5 --- README.md | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8374a4fb..594bde04 100644 --- a/README.md +++ b/README.md @@ -23,12 +23,8 @@ <img src="https://github.com/apache/mynewt-newt/actions/workflows/test_commands.yml/badge.svg"> <a/> -<a href="https://github.com/apache/mynewt-newt/actions/workflows/test_dump.yml"> - <img src="https://github.com/apache/mynewt-newt/actions/workflows/test_dump.yml/badge.svg"> -<a/> - -<a href="https://github.com/apache/mynewt-newt/actions/workflows/test_upgrade.yml"> - <img src="https://github.com/apache/mynewt-newt/actions/workflows/test_upgrade.yml/badge.svg"> +<a href="https://github.com/apache/mynewt-newt/actions/workflows/test_unit.yml"> + <img src="https://github.com/apache/mynewt-newt/actions/workflows/test_unit.yml/badge.svg"> <a/> # Newt @@ -110,8 +106,31 @@ with a description of the feature or submit a We love getting newt tests! Apache Mynewt is a huge undertaking, and improving code coverage is a win for every Apache Mynewt user. -Automated Newt tests are run in Travis. The test code can be found -[here](https://github.com/JuulLabs-OSS/mynewt-travis-ci). +Newt tests are regular Go tests and run in GitHub Actions on every pull +request. They can also be run locally from the repository root: + +```no-highlight +$ go test ./newt +``` + +Useful variants: + +```no-highlight +$ go test -v ./newt # show each test and newt's output +$ go test -v -run TestUpgrade ./newt # run only matching tests +$ go test -count=1 ./newt # ignore cached test results +``` + +Only Go and `git` are needed; the tests do not need network access or a +`newt` binary. The test binary runs itself as newt, and each test works on +a copy of a project from `newt/testdata` in a temporary directory. Remote +repositories used by the upgrade tests are local dummy repositories stored +as `git fast-export` streams in `newt/testdata/upgrade/dummy-repos`; these +tests ignore your global and system git configuration. + +New end-to-end tests can follow the same pattern: add a project under +`newt/testdata` and a `*_test.go` file in `newt/` that runs newt commands +against it. ## Writing Documentation
