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.

Sign up for GitHub

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

Add a section in the README on how to fix line break encoding issue #396

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a section in the README on how to fix line break encoding issue #396

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,26 @@ Then build automation-dashboard, that will compose all subviews.

In order to test subviews and automation dashboard locally, it is required not to publish the subviews archives to main repository, but to local repository of machine.

### Line break issue:
If you are building automation dashboard or subviews using different OS over time you can face an encoding issue. It usually manifest with
Copy link
Member

Choose a reason for hiding this comment

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

Please make sure to mention that it occurs particularly on Windows as it never occurred before on linux or Mac. It will probably never occur on Linux because you cannot merge it if on this repo because Jenkins compilations will fail.

a blank automation-dashboard page, when looking at the browser console a lot of warnings appear and some code can be recognized as error.

When you look at the differences with the master branch using git, messages like
`The file will have its original line endings in your working directory
warning: LF will be replaced by CRLF in ...` can appear for each file having an issue.

To fix the problem the encoding must be consistent in automation-dashboard and all the sub-projects. We will use Dos2Unix tool To achieve that.
Copy link
Member

Choose a reason for hiding this comment

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

To fix this issue, the encoding has to be consistent in automation-dashboard including all its sub-projects


Example: To encode all the files of the project from windows to unix encoding use the following:
- Open a terminal on the unix machine (where the project is)
- Go to the automation-dashboard project directory
- Use `find . -type f -print0 | xargs -0 dos2unix -s`

This command will convert all files that are not binary files.

Dos2Unix tool can convert files with DOS or Mac line breaks to Unix line breaks and vice versa.
Go to http://dos2unix.sourceforge.net/dos2unix.htm for more informations about the tool.

### What does grunt building do with subviews?

With the following tasks, grunt injects subviews in the dashboard, depending on the requested VERSION :
Expand Down