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

check-i18n.pl is linked out of directory #11247

Closed
yesennes opened this issue Oct 28, 2019 · 8 comments · Fixed by #11257
Closed

check-i18n.pl is linked out of directory #11247

yesennes opened this issue Oct 28, 2019 · 8 comments · Fixed by #11257

Comments

@yesennes
Copy link

yesennes commented Oct 28, 2019

Description

The file scripts/check-i18n.pl is a symbolic link to ../../matrix-react-sdk/scripts/check-i18n.pl. If I understand the project set up, we can't rely on that file existing there, it instead should link to ../matrix-react-sdk/scripts/check-i18n.pl. This doesn't seem to be causing problems with normal use, but can break some tools i.e. trying to use grep inside the project folder will break.

I can fix this really quick if someone can confirm its an issue and not me misunderstanding something.

Steps to reproduce

  • Clone the project in a directory without matrix-react-sdk in a sibling directory
  • ls -l scripts/check-i18n.pl

Symbolic links should point to files that exist.

Logs being sent: no

Version information

N/A
Centos 7

@turt2live
Copy link
Member

The project should not have the react-sdk within the riot-web directory, so the symlink is correct (if one were to follow the development instructions).

Realistically it probably shouldn't be a symlink, but the alternative is code duplication :(

@t3chguy
Copy link
Member

t3chguy commented Oct 28, 2019

Realistically it probably shouldn't be a symlink, but the alternative is code duplication :(

Could it not expose it like /~https://github.com/matrix-org/matrix-react-sdk/blob/develop/package.json#L32-L36

@turt2live
Copy link
Member

There was a reason why we didn't do that, but maybe yarn fixes it

@yesennes
Copy link
Author

@turt2live Oh, I see. The directions from build from source end up with the folders inside riot web, while the development instructions don't. Maybe we should consider changing that to make them consistant? Could be as simple as having scripts/fetch-develop.deps.sh pop a directory before it clones the sdks.

@jryans
Copy link
Collaborator

jryans commented Oct 28, 2019

It does seem like we're creating a trap for people by having scripts/fetch-develop.deps.sh arrange a different directory layout than would be used for full development mode...

I guess the tricky part is scripts/fetch-develop.deps.sh is used for CI as well, so we'd need to tune those steps if we change the script.

@turt2live
Copy link
Member

We shouldn't be encouraging people to use the CI scripts. If I have to rename that script to stop people using it, I will :|

The development instructions should be making no reference to that script.

@jryans
Copy link
Collaborator

jryans commented Oct 28, 2019

Let's just remove references to that script from the docs then.

@yesennes
Copy link
Author

yesennes commented Oct 28, 2019

Renaming seems like a good idea, fetch-develop.deps.sh not fetching developer dependencies seems misleading. Even after we remove it from the documentation, some people could stumble on it.

@jryans jryans self-assigned this Oct 29, 2019
jryans added a commit that referenced this issue Oct 29, 2019
This removes `fetch-develop.deps.sh` from the docs, as it's designed more for
use on CI environments and ends up causing confusion when used for anything
else.

Fixes #11247
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants