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

BUGFIX: Adjust contributing section to composer changes #3367

Merged
merged 1 commit into from
Jul 2, 2021

Conversation

kdambekalns
Copy link
Member

When installing for development purposes, --prefer-install=auto needs
to be used since Composer 2.1, see https://getcomposer.org/doc/06-config.md#preferred-install

When installing for development purposes, `--prefer-install=auto` needs
to be used since Composer 2.1, see https://getcomposer.org/doc/06-config.md#preferred-install
@@ -49,11 +49,11 @@ Contributing

If you want to contribute to Neos and want to set up a development environment, then follow these steps:

``composer create-project neos/neos-development-distribution neos-development dev-master --keep-vcs``
``composer create-project neos/neos-development-distribution neos-development dev-master --keep-vcs --prefer-install=auto``
Copy link
Member

Choose a reason for hiding this comment

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

the --keep-vcs is no longer needed then right?
Or is this for legacy composer?

Copy link
Member

Choose a reason for hiding this comment

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

I think it is still needed (https://getcomposer.org/doc/03-cli.md#create-project) though I'm unsure how composer 2.x really behaves for source install. At least it's not stated in the CLI option that it directly correlates with prefer-install

@albe
Copy link
Member

albe commented Jul 1, 2021

Interesting, TIL. Shouldn't we explicitly use source in the case of a development setup though?

Edit: Can we maybe even just add those preferred-install sections to the *-dev-distribution composer.jsons?

@mhsdesign
Copy link
Member

Edit: Can we maybe even just add those preferred-install sections to the *-dev-distribution composer.jsons?

That would be the most comfortable ;)
+1

@kdambekalns
Copy link
Member Author

the --keep-vcs is no longer needed then right?

It has nothing to do with the Neos and Framework repository handling, but you might want or need to change something in the development distribution, too. So it's still useful.

Shouldn't we explicitly use source

That's what I tried first, but it downloads everything as source then, even Symfony, Doctrine, … and it creates an error:

$ composer create-project neos/neos-development-distribution neos-development dev-master --prefer-install=source
Creating a "neos/neos-development-distribution" project at "./neos-development"
Installing neos/neos-development-distribution (dev-master 1ed89c0e66749361f5df7f15bfa490522e14fdff)
  - Syncing neos/neos-development-distribution (dev-master 1ed89c0) into cache
  - Installing neos/neos-development-distribution (dev-master 1ed89c0): Cloning 1ed89c0e66 from cache
Created project in /Users/karsten/neos-development


  [InvalidArgumentException]
  --prefer-source can not be used together with --prefer-install

Only --prefer-source works, but see above. :)

@kdambekalns
Copy link
Member Author

Can we maybe even just add those preferred-install sections to the *-dev-distribution composer.jsons?

Oh, yes! I didn't even really read that section close enough–I thought it was about ~/.composer/config.json 🙈

@albe
Copy link
Member

albe commented Jul 1, 2021

It has nothing to do with the Neos and Framework repository handling

D'oh, I didn't know that! Then the old explanation was misleading anyway.

Guess this is fine as a quick fix for now and let's check the composer.json preferred-install section in another PR?

@albe
Copy link
Member

albe commented Jul 2, 2021

Created issues for the two *-dev-distributions and will merge this as is now :)

@albe albe merged commit 15f1ecd into master Jul 2, 2021
@albe albe deleted the bugfix/dev-install-composer-instructions branch July 2, 2021 11:45
Sign up for free to 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.

None yet

3 participants