You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2020/08/16 21:12:31 UTC
[GitHub] [flink] XComp opened a new pull request #13165: [FLINK-18963][docs] Introduced IntelliJ subsection about adding a Copyright Profile for the Apache license.
XComp opened a new pull request #13165:
URL: https://github.com/apache/flink/pull/13165
## What is the purpose of the change
Instruction were added on how to add the Copyright Profile for the Apache license to IntelliJ.
## Brief change log
- Added a subsection to `docs/flinkDev/ide_setup.md` and `docs/flinkDev/idea_setup.zh.md`
## Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: no
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: no
- The S3 file system connector: no
## Documentation
- Does this pull request introduce a new feature? no
- If yes, how is the feature documented? no
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot commented on pull request #13165: [FLINK-18963][docs] Introduced IntelliJ subsection about adding a Copyright Profile for the Apache license.
Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #13165:
URL: https://github.com/apache/flink/pull/13165#issuecomment-674581051
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "0c04d957cb9a575618de52ddc94c290b2431e92a",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "0c04d957cb9a575618de52ddc94c290b2431e92a",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 0c04d957cb9a575618de52ddc94c290b2431e92a UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #13165: [FLINK-18963][docs] Introduced IntelliJ subsection about adding a Copyright Profile for the Apache license.
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #13165:
URL: https://github.com/apache/flink/pull/13165#issuecomment-674581051
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "0c04d957cb9a575618de52ddc94c290b2431e92a",
"status" : "SUCCESS",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5574",
"triggerID" : "0c04d957cb9a575618de52ddc94c290b2431e92a",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 0c04d957cb9a575618de52ddc94c290b2431e92a Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5574)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] tillrohrmann closed pull request #13165: [FLINK-18963][docs] Introduced IntelliJ subsection about adding a Copyright Profile for the Apache license.
Posted by GitBox <gi...@apache.org>.
tillrohrmann closed pull request #13165:
URL: https://github.com/apache/flink/pull/13165
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot commented on pull request #13165: [FLINK-18963][docs] Introduced IntelliJ subsection about adding a Copyright Profile for the Apache license.
Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #13165:
URL: https://github.com/apache/flink/pull/13165#issuecomment-674578819
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.
## Automated Checks
Last check on commit 0c04d957cb9a575618de52ddc94c290b2431e92a (Sun Aug 16 21:14:30 UTC 2020)
✅no warnings
<sub>Mention the bot in a comment to re-run the automated checks.</sub>
## Review Progress
* ❓ 1. The [description] looks good.
* ❓ 2. There is [consensus] that the contribution should go into to Flink.
* ❓ 3. Needs [attention] from.
* ❓ 4. The change fits into the overall [architecture].
* ❓ 5. Overall code [quality] is good.
Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
- `@flinkbot approve all` to approve all aspects
- `@flinkbot approve-until architecture` to approve everything until `architecture`
- `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
- `@flinkbot disapprove architecture` to remove an approval you gave earlier
</details>
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] tillrohrmann commented on a change in pull request #13165: [FLINK-18963][docs] Introduced IntelliJ subsection about adding a Copyright Profile for the Apache license.
Posted by GitBox <gi...@apache.org>.
tillrohrmann commented on a change in pull request #13165:
URL: https://github.com/apache/flink/pull/13165#discussion_r471297154
##########
File path: docs/flinkDev/ide_setup.md
##########
@@ -117,6 +117,32 @@ Nevertheless please make sure that code you add/modify in these modules still co
Enable scalastyle in Intellij by selecting Settings -> Editor -> Inspections, then searching for "Scala style inspections". Also Place `"tools/maven/scalastyle-config.xml"` in the `"<root>/.idea"` or `"<root>/project"` directory.
+### Copyright Profile
+
+Each file needs to include the Apache license as a header. This can be automated in IntelliJ by adding a Copyright profile:
+1. Open settings
+2. Go to Editor -> Copyright -> Copyright Profiles
+3. Add a new profile naming it `Apache`
+4. Add the following text as the license text:
+```
Review comment:
Missing line break before the backticks.
##########
File path: docs/flinkDev/ide_setup.zh.md
##########
@@ -117,6 +117,32 @@ Nevertheless please make sure that code you add/modify in these modules still co
Enable scalastyle in Intellij by selecting Settings -> Editor -> Inspections, then searching for "Scala style inspections". Also Place `"tools/maven/scalastyle-config.xml"` in the `"<root>/.idea"` or `"<root>/project"` directory.
+### Copyright Profile
+
+Each file needs to include the Apache license as a header. This can be automated in IntelliJ by adding a Copyright profile:
+1. Open settings
+2. Go to Editor -> Copyright -> Copyright Profiles
+3. Add a new profile naming it `Apache`
+4. Add the following text as the license text:
+```
Review comment:
Same here.
##########
File path: docs/flinkDev/ide_setup.md
##########
@@ -117,6 +117,32 @@ Nevertheless please make sure that code you add/modify in these modules still co
Enable scalastyle in Intellij by selecting Settings -> Editor -> Inspections, then searching for "Scala style inspections". Also Place `"tools/maven/scalastyle-config.xml"` in the `"<root>/.idea"` or `"<root>/project"` directory.
+### Copyright Profile
+
+Each file needs to include the Apache license as a header. This can be automated in IntelliJ by adding a Copyright profile:
+1. Open settings
+2. Go to Editor -> Copyright -> Copyright Profiles
+3. Add a new profile naming it `Apache`
+4. Add the following text as the license text:
+```
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
+5. Apply the changes.
Review comment:
This ordered list point does not appear with `5. Apply the changes` but `1. Apply the changes`.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org