Skip to content

docs: Clarify on README now to run tests - #236

Merged
vorburger merged 3 commits into
ipfs-shipyard:masterfrom
vorburger:patch-1
Jan 20, 2026
Merged

docs: Clarify on README now to run tests#236
vorburger merged 3 commits into
ipfs-shipyard:masterfrom
vorburger:patch-1

Conversation

@vorburger

@vorburgervorburger commented Feb 28, 2025

Copy link
Copy Markdown
Collaborator

Kubo must run with --enable-pubsub-experiment& and without --mount.

@ianopolous merge?

…le-pubsub-experiment` & and without `--mount`
@vorburger

Copy link
Copy Markdown
CollaboratorAuthor

1 workflow awaiting approval

@vorburger

Copy link
Copy Markdown
CollaboratorAuthor

Re. #237 and this, I've noticed that install-run-ipfs.sh also uses --routing=dhtclient - should that also be added to doc here?

It does not seem to help with those test failures, so I doubt that it's required.

Comment threadREADME.md Outdated
### Running tests

To run tests, IPFS daemon must be running on `127.0.0.1` interface.
To run tests, IPFS daemon must be running on `127.0.0.1` interface, with `--enable-pubsub-experiment`, and without `--mount`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The --mount is not the default, so why mention it?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cstamas I've no idea anymore why I wrote this, a year ago! I've removed it. (Squash and) merge as-is?

Removed the requirement for the IPFS daemon to run without `--mount` when running tests, based on PR code review feedback.
CopilotAI review requested due to automatic review settings January 19, 2026 19:19

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the README documentation to clarify the requirements for running tests. Specifically, it adds the requirement that the IPFS daemon must be run with the --enable-pubsub-experiment flag.

Changes:

  • Added --enable-pubsub-experiment flag requirement to the "Running tests" section

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vorburger
vorburger merged commit 02e900b into ipfs-shipyard:masterJan 20, 2026
1 check passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@vorburger@cstamas