Skip to content

[Bundles] Update best practices to use Symfony Flex and do not favor any CI tool #14505

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

Merged
merged 1 commit into from
Jan 15, 2021

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Oct 31, 2020

Fixes #10361

I think it's better to not show a complete Travis CI config, but instead document the intentions behind it. This way, everyone can implement them on their favorite CI tool.

Meanwhile, I removed the symfony/lts usage instead of the now recommended SYMFONY_REQUIRE env var.

* All supported major Symfony versions (e.g. both ``3.x`` and ``4.x`` if
support is claimed for both).

Thus, a bundle support PHP 7.3, 7.4 and 8.0, and Symfony 3.4 and 4.x should
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it still worth documenting v3.4?

Also for the travis config file, is it possible to use the langage toggle config feature php/xml/yaml but instead use it for toggling between for example github actions, travis, etc ?

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Thus, a bundle support PHP 7.3, 7.4 and 8.0, and Symfony 3.4 and 4.x should
Thus, a bundle supporting PHP 7.3, 7.4 and 8.0, and Symfony 3.4, 4.x and 5.x should

listing explicit versions is prone to be outdated after a while, but i think this is about the example, so getting outdated is ok.

Copy link
Contributor

@dbu dbu left a comment

Choose a reason for hiding this comment

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

thanks for the update. i find it a pitty to completely drop the example config file, it is quite nice to see a full example (also great to quickstart a repo). can we preserve that file somehow somewhere? i was thinking of putting it in a gist, but that is a bit fragile and tied to a personal account. linking a concrete example in a popular OSS bundle is also prone to not work at some point. could we have a non-rst file in the doc that can be downloaded?


* The lower bound of their dependencies (by running ``composer update --prefer-lowest``);
* The supported PHP versions;
* All supported major Symfony versions (e.g. both ``3.x`` and ``4.x`` if
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* All supported major Symfony versions (e.g. both ``3.x`` and ``4.x`` if
* All supported major Symfony versions (e.g. both ``4.x`` and ``5.x`` if

@javiereguiluz
Copy link
Member

I disagree with this 😐 I'd love to provide a realistic example that readers can copy+paste to test their bundles.

@wouterj
Copy link
Member Author

wouterj commented Nov 3, 2020

Alright, what do we do then? Given Travis changes its paid plan, does it makes sense to replace the Travis config with GitHub actions? (as it'll probably be a more common use-case for new bundles starting now)

Or as, suggested by @noniagriconomie, do we want tabs? The "issue" with tabs is that we need to explicitly add them to the Sphinx config.

@wouterj
Copy link
Member Author

wouterj commented Nov 8, 2020

Something else I was just thinking: what about creating a template repository for new bundles? That would include the README, GitHub actions config, main directories, etc.

@javiereguiluz
Copy link
Member

That could be a nice idea. I feel like the "onboarding" for bundle authors has too much friction. We could have a make:bundle maker, a template repository, better docs about how to create a bundle and support multiple Symfony versions, how to create a "fake" Symfony app to functional test the bundle, etc.

@OskarStark OskarStark changed the title [Bundles]Update best practices to use Symfony Flex and do not favor any CI tool [Bundles] Update best practices to use Symfony Flex and do not favor any CI tool Dec 7, 2020
@javiereguiluz javiereguiluz merged commit b1572dd into symfony:4.4 Jan 15, 2021
@javiereguiluz
Copy link
Member

Thank you Wouter!

@wouterj wouterj deleted the issue-10361/build-config-bundles branch March 12, 2021 22:30
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.

5 participants