Skip to content

[FrameworkBundle] Document env vars in framework.ide #15306

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
May 4, 2021

Conversation

javiereguiluz
Copy link
Member

This fixes #15303.

@MatTheCat, please review this. Thank you!

@javiereguiluz javiereguiluz added this to the 5.3 milestone May 3, 2021
@javiereguiluz javiereguiluz force-pushed the fix_15303 branch 3 times, most recently from 84fd754 to ac51668 Compare May 3, 2021 11:09
@javiereguiluz
Copy link
Member Author

@Nyholm there's a validation error related to a code example of this article and I don't know how to fix it. If you have some time, please give me a clue to solve it. Thanks!

@Nyholm
Copy link
Member

Nyholm commented May 3, 2021

Thank you for the ping.

The error message basically means: "if you copy/paste this code example to your app, you would get the following error message: "

Environment variable not found: "CODE_EDITOR".

To fix this, we could define the environment variable CODE_EDITOR (or ugly trick it by defining parameter env(CODE_EDITOR): ''.

In this particular case (considering how we usually do examples) I suggest just to ignore this error.

@javiereguiluz
Copy link
Member Author

Thanks for the info ... but sadly we can't ignore this error because it will make all future builds in 5.x and up to fail (and also, GitHub sends an email for each failure, so it will be a bit annoying).

Maybe we can tweak the validator to never check if an env var exists?

@Nyholm
Copy link
Member

Nyholm commented May 3, 2021

Im not sure that is true.

This CI is using a baseline. So it first detects from where you branched out. It will create the baseline there. Secondly, it applies the patch and run the check again. The errors you see in the PR review is the "new" errors.

This is the exact workflow symfony/symfony is using for psalm.

@javiereguiluz
Copy link
Member Author

OK. I didn't understand the behavior. Sorry! Everything is OK then. Thanks!

@javiereguiluz javiereguiluz merged commit aa83c1b into symfony:5.x May 4, 2021
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.

[FrameworkBundle][HttpKernel] Move IDE file link formats from Framework…
5 participants