Skip to content

Merge the sbt dotty plugin in this repo #2361

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, 2017

Conversation

smarter
Copy link
Member

@smarter smarter commented May 3, 2017

@smarter smarter requested a review from felixmulder May 3, 2017 17:44
@smarter
Copy link
Member Author

smarter commented May 3, 2017

I've also updated https://github.com/lampepfl/dotty-example-project to use the sbt-dotty plugin so things should be much less confused now. However, it is very important that someone takes the time to make a more complex examples that illustrates cross-compilation with dotty, and I don"t have time to do that now.

@smarter
Copy link
Member Author

smarter commented May 3, 2017

Note: I think it'd make sense to make the scripted tests a separate job, but that will slow the CI down unless we increase the number of jobs run in parallel.

<a href="https://github.com/smarter/dotty-example-project">
dotty-example-project
</a>, but let’s you skip building dotty from scratch.
See the <a href="https://github.com/lampepfl/dotty-example-project">example project</a>.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't like removing this, but I'm sure your reason is that we'd need to keep it in sync with the example project. I feel that it will take everyone who's interested in trying Dotty through multiple hoops. I'd like it to just be "google dotty, find webpage, minimal sbt config, run dotty". Instead of "google dotty, find webpage, find link to example project, read most of README to know which options to use, set up sbt config, run dotty".

Maybe we should restructure the intro page and put this information at the top after the logo and show a condensed version of the dotty example project README which we also refer to for more information.

Copy link
Member Author

Choose a reason for hiding this comment

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

Instead of "google dotty, find webpage, find link to example project, read most of README to know which options to use, set up sbt config, run dotty".

We could make an sbt new template and add the command to create it on the homepage: http://www.scala-sbt.org/0.13/docs/sbt-new-and-Templates.html

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe we should restructure the intro page and put this information at the top after the logo and show a condensed version of the dotty example project README which we also refer to for more information.

I really don't want to duplicate information, we're already doing a bad job at keeping one copy of our documentation up to date, and we completely fail for information in multiple places (the homepage talked about a very old version of the sbt-dotty plugin).

for a simple sbt project that compiles code with Dotty
* [sbt-dotty](https://github.com/felixmulder/sbt-dotty) an sbt plugin that
takes care of all dependencies and settings needed to get a Dotty sbt project
See the [example project](https://github.com/lampepfl/dotty-example-project).
Copy link
Contributor

Choose a reason for hiding this comment

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

We could just put the config info from the front-page into an _include and as such we don't need to duplicate any info here.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll let you do that in a follow-up PR ;)

@felixmulder
Copy link
Contributor

I'm fine with increasing the number of jobs running in parallel on the CI. I just haven't gotten to it because of flatMap(Oslo).

@felixmulder
Copy link
Contributor

Also, changes to example project README look very nice 👍

@smarter
Copy link
Member Author

smarter commented May 4, 2017

OK with merging this?

@smarter smarter merged commit 13443fa into scala:master May 4, 2017
@felixmulder
Copy link
Contributor

I'm fine with it, but we should really clean it up. I'm not sure we should even have an example project as there is an example project in sbt-dotty.

@smarter
Copy link
Member Author

smarter commented May 4, 2017

Having an example project as a separate repo make it easy for someone to experiment with, they can just git clone it and treat is as a starting point for their project. And I'm pretty sure we need at least two example projects: one that just compiles with dotty and one that cross-compiles, they both can be useful.

@felixmulder
Copy link
Contributor

Sure, but in that case we should move the documentation to this repo and have it as an include and then in dotty-example-project refer to this repo and the docs.

@allanrenucci allanrenucci deleted the add/sbt-dotty branch December 14, 2017 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants