Skip to content

Local tests script for contribution not executing cargo doc #850

Closed

Description

@rish-singhal

The contribution guideline file https://github.com/rust-bitcoin/rust-bitcoin/blob/master/CONTRIBUTING.md suggests that there exist a script ci.sh

BITCOIN_MSRV=1.29.0 ./contrib/ci.sh

But I couldn't find this file in the repository, so I opened the contrib directory and found out test.sh. Recently, in my PR, I found out that docs tests were failing on github. But locally running ./contrib/test.sh did not pointed out that.

I believe cargo doc is not being executed in ./contrib/test.sh script for local testing. I am not sure if ./contrib/test.sh was supposed to check documentation tests too.

Activity

  1. apoelstra commented on Feb 26, 2022

    @apoelstra
    Member

    Yes, both of these are bugs:

    • contributing.md should have the correct filename, test.sh
    • test.sh should be able to run the doc tests (should be gated by an environment var, similar to the existing fuzztests etc)
  2. added a commit that references this issue on Jun 10, 2024
    a8c9ea6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions