Added integration with sbt-header like in akka-http #24594

kelebra · 2018-02-22T07:06:38Z

This PR introduces integration with sbt-headers discussed in this PR based on implementation in another PR from akka-http in order to automate population of copyright header in source code.

Main points of changes: project/plugins.sbt, project/CopyrightHeader.scala, build.sbt. All other files are changed due to execution of headerCreate sbt command.

I am no sbt expert however this seemed like a low hanging fruit which could improve contribution experience for others especially the ones who contribute to akka for the first time.

akka-ci · 2018-02-22T07:11:04Z

Thank you for your pull request! After a quick sanity check one of the team will reply with 'OK TO TEST' to kick off our automated validation on Jenkins. This compiles the project, runs the tests, and checks for things like binary compatibility and source code formatting. When two team members have also manually reviewed and (perhaps after asking for some amendments) accepted your contribution, it should be good to be merged.

For more details about our contributing process, check out CONTRIBUTING.md - and feel free to ask!

# Conflicts: # akka-remote/src/main/java/akka/remote/artery/aeron/AeronErrorLog.java # akka-testkit-typed/src/main/scala/akka/testkit/typed/javadsl/ExplicitlyTriggeredScheduler.scala

johanandren · 2018-02-22T07:29:22Z

OK TO TEST

ktoso · 2018-02-22T07:53:39Z

Excellent, I'm all for merging it -- perhaps after we merge things for today's release.

patriknw

great, finally a smart pattern that preserves the original years

patriknw · 2018-02-22T08:00:08Z

akka-actor-typed/src/main/scala/akka/actor/typed/javadsl/TimerScheduler.scala

 /**
 * Copyright (C) 2017-2018 Lightbend Inc. <https://www.lightbend.com>
 */
+


do we have to add these newlines?

In my opinion that looks consistent with akka-http

They're also there in akka-http indeed, but they do look a bit strange to me as well. Do we want them?

patriknw · 2018-02-22T08:00:49Z

akka-actor-typed/src/main/scala/akka/actor/typed/package.scala

@@ -1,3 +1,7 @@
+/*
+ * Copyright (C) 2018 Lightbend Inc. <https://www.lightbend.com>
+ */


patriknw · 2018-02-22T08:05:48Z

akka-actor/src/main/java/akka/dispatch/forkjoin/package-info.java

 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain, as explained at
 * http://creativecommons.org/publicdomain/zero/1.0/
 */


Good that it doesn't change that

Do we have any other headers that have both Lightbend and some other copyright notice? When we copy code from elsewhere (when the license permits) we preserve the original copyright notice.

akka-protobuf

akka-persistence

akka-ci · 2018-02-22T08:42:11Z

Test FAILed.

akka-ci · 2018-02-23T02:00:14Z

Test FAILed.

kelebra · 2018-02-23T05:14:08Z

Things that changed after last commits:

In sync with master.
Added header generation on compilation in order to simplify regular development.
Added tests into scope. Actually more files are formatted now especially in akka-testkit-typed and other new modules.

akka-ci · 2018-02-23T05:25:46Z

Test FAILed.

akka-ci · 2018-02-23T05:35:36Z

Test FAILed.

akka-ci · 2018-02-23T06:00:39Z

Test FAILed.

ktoso · 2018-02-23T07:32:01Z

akka-actor-tests/src/test/java/akka/actor/ActorSystemTest.java

+
+/**
  * Copyright (C) 2009-2018 Lightbend Inc. <https://www.lightbend.com>
  */ 


looks wrong?

Probably something due to extra space in the beginning of each line. I would actually expect MiMa to format it correctly or complain about it. Anyway this could be also fixed with a bit of enhancing of detection regexp.

akka-ci · 2018-02-24T03:18:20Z

Test FAILed.

akka-ci · 2018-02-24T05:10:23Z

Test PASSed.

kelebra · 2018-02-24T05:23:51Z

Looks like all done. Sorry for mess, looks like I actually broke build somehow accidentally changing line endings from LF to CRLF (issues with local setup).

Please let me know if there is anything that should be done on this PR.

Philippus · 2018-03-01T09:05:43Z

akka-actor-tests/src/test/java/akka/actor/JavaAPITestActor.java

@@ -1,3 +1,7 @@
+/*
+ * Copyright (C) 2018 Lightbend Inc. <https://www.lightbend.com>


should this be 2011-2018 in this case and similarly for other files that did not have a copyright header yet? Or do we not care?

I think the sbt-header configuration just adding 2018 is OK. We could consider manually updating files we know are older, but I'm OK with the header like this as well. AFAIK the year in a copyright header is mostly there for informational purposes, not really legal ones.

raboof

We might want to remove the extra newlines and look into the problem @ktoso noticed, but in general super nice PR! Looking forward to having it in :)

kelebra · 2018-03-02T04:47:09Z

Thanks for further steps, I will revisit this PR tomorrow. Probably line endings should not be an issue and will start from there.

kelebra · 2018-03-03T04:00:01Z

Actually, looks like it is an issue 😢 See this rejected PR for more info, looks like play and others are okay with it. I am trying to somehow hack around it but so far it looks like change cannot be done from plugin user side.

PR closed for now as I am reiterating in the same branch. Let me know if you will change your mind regarding line endings.

kelebra · 2018-03-03T05:44:08Z

So unfortunately no way around it so far. Root cause of these extra line ending is here. Sorry guys but it is pretty much closed by final.

Added integration with sbt-header like in akka-http

e2492fc

kelebra added 2 commits February 22, 2018 01:14

Merge branch 'master' into sbt-header-integration

9e9dee7

# Conflicts: # akka-remote/src/main/java/akka/remote/artery/aeron/AeronErrorLog.java # akka-testkit-typed/src/main/scala/akka/testkit/typed/javadsl/ExplicitlyTriggeredScheduler.scala

Pushing more results of headerCreate based on merge

b3b3b72

akka-ci added the validating PR is currently being validated by Jenkins label Feb 22, 2018

patriknw reviewed Feb 22, 2018

View reviewed changes

akka-ci added needs-attention Indicates a PR validation failure (set by CI infrastructure) and removed validating PR is currently being validated by Jenkins labels Feb 22, 2018

Merge branch 'master' into sbt-header-integration

736b08e

Added header population on compilation

7eb207d

akka-ci added validating PR is currently being validated by Jenkins and removed needs-attention Indicates a PR validation failure (set by CI infrastructure) labels Feb 23, 2018

Fixed duplication in formatting

e8235b7

akka-ci added validating PR is currently being validated by Jenkins needs-attention Indicates a PR validation failure (set by CI infrastructure) and removed validating PR is currently being validated by Jenkins labels Feb 23, 2018

akka-ci added the needs-attention Indicates a PR validation failure (set by CI infrastructure) label Feb 23, 2018

Execution of test:compile. Fixing code formatting and copyright.

bce74d5

akka-ci added the validating PR is currently being validated by Jenkins label Feb 23, 2018

akka-ci added needs-attention Indicates a PR validation failure (set by CI infrastructure) and removed validating PR is currently being validated by Jenkins labels Feb 23, 2018

ktoso reviewed Feb 23, 2018

View reviewed changes

LF endings

7cbf7b7

Fixing test case which got impacted after adding linebreak in copyright

a318655

akka-ci added validating PR is currently being validated by Jenkins tested PR that was successfully built and tested by Jenkins and removed needs-attention Indicates a PR validation failure (set by CI infrastructure) validating PR is currently being validated by Jenkins labels Feb 24, 2018

Philippus reviewed Mar 1, 2018

View reviewed changes

raboof reviewed Mar 1, 2018

View reviewed changes

kelebra closed this Mar 3, 2018

kelebra deleted the sbt-header-integration branch March 3, 2018 01:33

kelebra mentioned this pull request Mar 3, 2018

Issue 24594: Integration with sbt-headers and initial header population. #24652

Closed

ktoso mentioned this pull request Mar 13, 2018

Issue 24594: Integration with sbt-headers and initial header population. #24715

Merged

johanandren modified the milestone: 2.5.12 Mar 13, 2018

ktoso modified the milestone: 2.5.12 Mar 13, 2018

		@@ -1,3 +1,7 @@
		/*
		* Copyright (C) 2018 Lightbend Inc. <https://www.lightbend.com>

Added integration with sbt-header like in akka-http #24594

Added integration with sbt-header like in akka-http #24594

Uh oh!

Conversation

kelebra commented Feb 22, 2018

Uh oh!

akka-ci commented Feb 22, 2018

Uh oh!

johanandren commented Feb 22, 2018

Uh oh!

ktoso commented Feb 22, 2018

Uh oh!

patriknw left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

akka-ci commented Feb 22, 2018

Uh oh!

akka-ci commented Feb 23, 2018

Uh oh!

kelebra commented Feb 23, 2018

Uh oh!

akka-ci commented Feb 23, 2018

Uh oh!

akka-ci commented Feb 23, 2018

Uh oh!

akka-ci commented Feb 23, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

akka-ci commented Feb 24, 2018

Uh oh!

akka-ci commented Feb 24, 2018

Uh oh!

kelebra commented Feb 24, 2018

Uh oh!

Philippus Mar 1, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

raboof left a comment

Choose a reason for hiding this comment

Uh oh!

kelebra commented Mar 2, 2018

Uh oh!

kelebra commented Mar 3, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kelebra commented Mar 3, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Philippus Mar 1, 2018 •

edited

Loading

kelebra commented Mar 3, 2018 •

edited

Loading