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

BugZilla 518578 : Let users to use .Chefile in addition to Chefile #5471

Merged
merged 3 commits into from
Jul 18, 2017

Conversation

benoitf
Copy link
Contributor

@benoitf benoitf commented Jun 27, 2017

What does this PR do?

It allows people to have Chefile hidden by default on Unix systems (like many metadata information not related directly to the project)

What issues does this PR fix or reference?

https://bugs.eclipse.org/bugs/show_bug.cgi?id=518578

Changelog

Handle .Chefile filename in addition to Chefile

Release Notes

Handle .Chefile filename in addition to Chefile. If both files are present, an error is reported.

Docs PR

eclipse-che/che-docs#248

Change-Id: Ie290a4550ccbdcc9aac64cb0c3bc60ac434a2ed8
Signed-off-by: Florent BENOIT fbenoit@redhat.com

@benoitf benoitf requested a review from slemeur June 27, 2017 07:39
@benoitf benoitf self-assigned this Jun 27, 2017
@benoitf benoitf added kind/enhancement A feature request - must adhere to the feature request template. status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. labels Jun 27, 2017
@benoitf benoitf requested a review from sunix June 27, 2017 07:40
Copy link
Contributor

@slemeur slemeur left a comment

Choose a reason for hiding this comment

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

👍

Log.getLogger().debug('The alternate file .Chefile is present at ', this.dotCheFile);
this.cheFile = this.dotCheFile;
} catch (e) {
Log.getLogger().debug('No chefile defined, use default settings');
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe this error message can be improved now:

  • chefile --> Chefile
  • and maybe add the possibility to use Chefile: "No Chefile or .Chefile defined, use default settings"

Copy link
Contributor

@apupier apupier left a comment

Choose a reason for hiding this comment

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

We talked about throwing an error if Chefile and .Chefile are both provided. I think that it is not implemented in this PR.
Is it by choice? Don't want to do it anymore? or want to provide it in a separate PR?

@benoitf
Copy link
Contributor Author

benoitf commented Jun 27, 2017

@apupier it's not implemented by this PR. I thought that maybe it would help if there is always a winner (no error reported). Chefile was always winning over .Chefile. You think that raising an error if the two are available will be more user friendly ? (error case vs winner case)

@codenvy-ci
Copy link

Build # 2924 - FAILED

Please check console output at https://ci.codenvycorp.com/job/che-pullrequests-build/2924/ to view the results.

@apupier
Copy link
Contributor

apupier commented Jun 27, 2017

@apupier it's not implemented by this PR. I thought that maybe it would help if there is always a winner (no error reported). Chefile was always winning over .Chefile. You think that raising an error if the two are available will be more user friendly ? (error case vs winner case)

I think that it is better to have the error case. it avoids the user to start modifying the wrong Chefile
Do we have a third point of view to settle?

Anyway, I will be happy with both cases (error or winner). Just I think the error one is slightly better.

@benoitf
Copy link
Contributor Author

benoitf commented Jun 27, 2017

@apupier I will modify the pull request to throw the error.

@benoitf
Copy link
Contributor Author

benoitf commented Jun 27, 2017

ok updated

@codenvy-ci
Copy link

@TylerJewell
Copy link

TylerJewell commented Jun 27, 2017 via email

@benoitf
Copy link
Contributor Author

benoitf commented Jun 27, 2017

It is case sensitive (on operating system that supports it)

@benoitf
Copy link
Contributor Author

benoitf commented Jun 27, 2017

so should I keep .Chefile or use .chefile ( in addition to Chefie)

@TylerJewell
Copy link

I would prefer .chefile as the only option. However, I don't see the harm in supporting both .chefile and .Chefile.

@apupier
Copy link
Contributor

apupier commented Jun 28, 2017

from an IDE point of view, the filters are on .* names so there is no difference.

Copy link
Contributor

@sunix sunix left a comment

Choose a reason for hiding this comment

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

LGTM

…t allows to use a hidden file format

Change-Id: Ie290a4550ccbdcc9aac64cb0c3bc60ac434a2ed8
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
…file. It allows to use a hidden file format

Change-Id: I0593a874ab5307e41ebf0437600fc5f4cf98f737
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
…file. It allows to use a hidden file format

Change-Id: Ia598346149941fe9d8338498e6a07dd3283d8430
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
@benoitf
Copy link
Contributor Author

benoitf commented Jul 18, 2017

I've added support then to Chefile, .chefile and .Chefile

@benoitf benoitf removed the status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. label Jul 18, 2017
@benoitf benoitf added this to the 5.15.0 milestone Jul 18, 2017
@benoitf benoitf merged commit 32d3545 into master Jul 18, 2017
@benoitf benoitf deleted the bz-518578 branch July 18, 2017 07:37
JPinkney pushed a commit to JPinkney/che that referenced this pull request Aug 17, 2017
…clipse-che#5471)

* BugZilla 518578 : Let users to use .Chefile in addition to Chefile. It allows to use a hidden file format

Change-Id: Ie290a4550ccbdcc9aac64cb0c3bc60ac434a2ed8
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement A feature request - must adhere to the feature request template.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants