Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Which branch should be used? #82

Closed
jpresley23 opened this issue Feb 6, 2017 · 6 comments
Closed

Which branch should be used? #82

jpresley23 opened this issue Feb 6, 2017 · 6 comments
Assignees
Labels
Bug Bug report or pull requests that addresses a bug Documentation Updates to documentation

Comments

@jpresley23
Copy link

The repository defaults to showing dev branch and it looks like that is the branch with active development. master hasn't been updated in a few years. Which branch do you recommend we install?

@johnpbloch
Copy link
Contributor

dev is the recommended branch.

@jpresley23
Copy link
Author

Thanks for the clarification. Should the installation instructions be updated?

@XedinUnknown
Copy link

Same question.

When accessing the repo via web interface, dev appears to be the default branch. On that branch, it says to depend on dev-master. But the usage instructions below are wrong for dev-master. As an example, WP_Mock::activateStrictMode() does not exist, and WP_Mock::userFunction() cannot be used for WP functions.
Also, unless feeling adventurous, developers should not depend on a branch, the head of which can change, and should depend on a version constraint, e.g. ^0.1.1. Otherwise, they risk suddenly one day not being able to run tests, because WP Mock can break BC unexpectedly. However, the instructions say to depend on dev-master...

@csrui
Copy link

csrui commented Mar 22, 2017

If dev is the recommended branch shouldn't the readme reflect that?

composer require --dev 10up/wp_mock:dev-master

@lloc
Copy link

lloc commented Mar 27, 2017

composer require --dev 10up/wp_mock:dev-master

seems not to install the expected branch. I had to use

composer require --dev 10up/wp_mock:dev-dev

instead.

Khristophor pushed a commit to Khristophor/wp_mock that referenced this issue Apr 30, 2017
@ericmann ericmann self-assigned this May 27, 2017
@ericmann ericmann added Bug Bug report or pull requests that addresses a bug Documentation Updates to documentation labels May 27, 2017
@ericmann
Copy link
Collaborator

Readme has been updated. We'll be eventually (I hope) moving to tagged releases in the near future to help further clarify things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Bug report or pull requests that addresses a bug Documentation Updates to documentation
Projects
None yet
Development

No branches or pull requests

6 participants