Automatically add copyright header upon creating a new file #8984
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
korthout
approved these changes
Mar 25, 2022
There was a problem hiding this comment.
Excellent! This will be a big QoL improvement 👍 It happens so often that I check in new classes without the license, but no more! 🚀
I did a bit of testing and it works really well. I've found 2 differences to the license headers being added via maven.
First, a blank line is added between the license header and the package definition. This is because of a formatting setting in IntelliJ.
🔧 Please disable it by adding to the .idea/copyright/profiles_settings.xml:
<LanguageOptions name="__TEMPLATE__">
<option name="addBlankAfter" value="false" />
</LanguageOptions>I've described the other difference in the comments.
remcowesterhoud
force-pushed
the
automatic_copyright_header
branch
from
853edad
to
9be0ad0
Compare
|
bors merge |
zeebe-bors-camunda bot
added a commit
that referenced
this pull request
Apr 1, 2022
8984: Automatically add copyright header upon creating a new file r=remcowesterhoud a=remcowesterhoud ## Description <!-- Please explain the changes you made here. --> These settings in intellij will automatically add the correct copyright header to a new file that's created. By default it will add the Zeebe 1.1 license header. There are 5 exceptions to this: 1. zeebe-java-client 2. zeebe-exporter-api 3. zeebe-protocol 4. zeebe-gateway-protocol-impl 5. zeebe-bpmn-model For these 5 modules we will automatically add the Apache 2.0 license header. The Go client should also be included in this list, however IntelliJ scopes only support the addition of packages. Since these packages are a Java concept we cannot include the Go files to these exceptions. No copyright header will be added automatically for new files in the go client. Co-authored-by: Remco Westerhoud <remco@westerhoud.nl>
|
Timed out. |
|
bors retry |
zeebe-bors-camunda bot
added a commit
that referenced
this pull request
Apr 1, 2022
8984: Automatically add copyright header upon creating a new file r=remcowesterhoud a=remcowesterhoud ## Description <!-- Please explain the changes you made here. --> These settings in intellij will automatically add the correct copyright header to a new file that's created. By default it will add the Zeebe 1.1 license header. There are 5 exceptions to this: 1. zeebe-java-client 2. zeebe-exporter-api 3. zeebe-protocol 4. zeebe-gateway-protocol-impl 5. zeebe-bpmn-model For these 5 modules we will automatically add the Apache 2.0 license header. The Go client should also be included in this list, however IntelliJ scopes only support the addition of packages. Since these packages are a Java concept we cannot include the Go files to these exceptions. No copyright header will be added automatically for new files in the go client. Co-authored-by: Remco Westerhoud <remco@westerhoud.nl>
|
bors cancel |
These settings in intellij will automatically add the correct copyright header to a new file that's created. By default it will add the Zeebe 1.1 license header. There are 5 exceptions to this: 1. zeebe-java-client 2. zeebe-exporter-api 3. zeebe-protocol 4. zeebe-gateway-protocol-impl 5. zeebe-bpmn-model For these 5 modules we will automatically add the Apache 2.0 license header. The Go client should also be included in this list, however IntelliJ scopes only support the addition of packages. Since these packages are a Java concept we cannot include the Go files to these exceptions. No copyright header will be added automatically for new files in the go client.
remcowesterhoud
force-pushed
the
automatic_copyright_header
branch
from
9be0ad0
to
569f7d2
Compare
|
Canceled. |
|
bors merge |
zeebe-bors-camunda bot
added a commit
that referenced
this pull request
Apr 1, 2022
8984: Automatically add copyright header upon creating a new file r=remcowesterhoud a=remcowesterhoud ## Description <!-- Please explain the changes you made here. --> These settings in intellij will automatically add the correct copyright header to a new file that's created. By default it will add the Zeebe 1.1 license header. There are 5 exceptions to this: 1. zeebe-java-client 2. zeebe-exporter-api 3. zeebe-protocol 4. zeebe-gateway-protocol-impl 5. zeebe-bpmn-model For these 5 modules we will automatically add the Apache 2.0 license header. The Go client should also be included in this list, however IntelliJ scopes only support the addition of packages. Since these packages are a Java concept we cannot include the Go files to these exceptions. No copyright header will be added automatically for new files in the go client. Co-authored-by: Remco Westerhoud <remco@westerhoud.nl>
|
Timed out. |
|
Don't be lazy now bors 😢 bors merge |
zeebe-bors-camunda bot
added a commit
that referenced
this pull request
Apr 1, 2022
8984: Automatically add copyright header upon creating a new file r=remcowesterhoud a=remcowesterhoud ## Description <!-- Please explain the changes you made here. --> These settings in intellij will automatically add the correct copyright header to a new file that's created. By default it will add the Zeebe 1.1 license header. There are 5 exceptions to this: 1. zeebe-java-client 2. zeebe-exporter-api 3. zeebe-protocol 4. zeebe-gateway-protocol-impl 5. zeebe-bpmn-model For these 5 modules we will automatically add the Apache 2.0 license header. The Go client should also be included in this list, however IntelliJ scopes only support the addition of packages. Since these packages are a Java concept we cannot include the Go files to these exceptions. No copyright header will be added automatically for new files in the go client. Co-authored-by: Remco Westerhoud <remco@westerhoud.nl>
|
Timed out. |
|
😡 |
deepthidevaki
added
the
version:8.1.0-alpha1
Zelldon
added
the
version:8.1.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
These settings in intellij will automatically add the correct copyright header to a new file that's created. By default it will add the Zeebe 1.1 license header. There are 5 exceptions to this:
For these 5 modules we will automatically add the Apache 2.0 license header.
The Go client should also be included in this list, however IntelliJ scopes only support the addition of packages. Since these packages are a Java concept we cannot include the Go files to these exceptions. No copyright header will be added automatically for new files in the go client.
Definition of Done
Not all items need to be done depending on the issue and the pull request.
Code changes:
backport stable/1.3) to the PR, in case that fails you need to create backports manually.Testing:
Documentation: