You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@bookkeeper.apache.org by GitBox <gi...@apache.org> on 2022/05/11 10:04:29 UTC
[GitHub] [bookkeeper] CalvinKirs opened a new pull request, #3269: Fix dead link and add CI check
CalvinKirs opened a new pull request, #3269:
URL: https://github.com/apache/bookkeeper/pull/3269
Descriptions of the changes in this PR:
### Motivation
I found some dead links while reading the README, to avoid this, I added a CI check.
### Changes
- Fix the dead link in README
- Add the markdown-link-check check
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] nicoloboschi commented on a diff in pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
nicoloboschi commented on code in PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269#discussion_r877177091
##########
.github/workflows/dead-link-checker.yaml:
##########
@@ -0,0 +1,42 @@
+# 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.
+
+name: Dead Link Checker
+
+on:
+ push:
+ paths:
+ - '**.md'
+ pull_request:
+ branches:
+ - master
+ - branch-*
+
+concurrency:
+ group: dlc-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ CheckDeadLinks:
Review Comment:
please use kebab-case (check-dead-links)
##########
.github/workflows/dead-link-checker.yaml:
##########
@@ -0,0 +1,42 @@
+# 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.
+
+name: Dead Link Checker
+
+on:
+ push:
+ paths:
Review Comment:
this should be included also in the pull_request config?
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] CalvinKirs commented on a diff in pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
CalvinKirs commented on code in PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269#discussion_r870895207
##########
.github/workflows/dead-link-checker.yaml:
##########
@@ -0,0 +1,36 @@
+# 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.
+
+name: Dead Link Checker
+
+on:
+ pull_request:
+
+concurrency:
+ group: dlc-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ CheckDeadLinks:
+ runs-on: ubuntu-latest
+ timeout-minutes: 30
Review Comment:
Hi, I've thought of doing that, but if someone adds MD files to another dir, that may result in frequent maintenance of this directory (most times. people probably forget to do this).
It's a simple CI, so I'd rather run it for every PR, WDYT?
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] nicoloboschi merged pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
nicoloboschi merged PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] CalvinKirs commented on pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
CalvinKirs commented on PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269#issuecomment-1126740566
Good to go, PTAL, thx @dlg99 @nicoloboschi
ps: I ignored some dead link checks because I'm not sure what the correct one should be, maybe we can create an issue to see if other familiar people are interested in doing it.
Another CI fail has nothing to do with this, maybe we need to rerun
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] nicoloboschi commented on pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
nicoloboschi commented on PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269#issuecomment-1140835753
rerun failure checks
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] CalvinKirs commented on a diff in pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
CalvinKirs commented on code in PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269#discussion_r870952432
##########
.github/workflows/dead-link-checker.yaml:
##########
@@ -0,0 +1,36 @@
+# 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.
+
+name: Dead Link Checker
+
+on:
+ pull_request:
+
+concurrency:
+ group: dlc-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ CheckDeadLinks:
+ runs-on: ubuntu-latest
+ timeout-minutes: 30
Review Comment:
I didn't notice before that there is such a way to determine the file type 🤣
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] dlg99 commented on a diff in pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
dlg99 commented on code in PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269#discussion_r870548360
##########
.github/workflows/dead-link-checker.yaml:
##########
@@ -0,0 +1,36 @@
+# 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.
+
+name: Dead Link Checker
+
+on:
+ pull_request:
+
+concurrency:
+ group: dlc-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ CheckDeadLinks:
+ runs-on: ubuntu-latest
+ timeout-minutes: 30
Review Comment:
We only need to run this if select dirs have changes (e.g. `site3/`) and can skip for majority of the PRs
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] CalvinKirs commented on a diff in pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
CalvinKirs commented on code in PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269#discussion_r877195015
##########
.github/workflows/dead-link-checker.yaml:
##########
@@ -0,0 +1,42 @@
+# 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.
+
+name: Dead Link Checker
+
+on:
+ push:
+ paths:
Review Comment:
thanks you for pointing it out
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] CalvinKirs commented on pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
CalvinKirs commented on PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269#issuecomment-1123538539
> cool! you need to exclude the new file from the license check
Thanks for your reminder, I will exclude all JSON files, it's not necessary to check the license.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] CalvinKirs commented on a diff in pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
CalvinKirs commented on code in PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269#discussion_r877194060
##########
.github/workflows/dead-link-checker.yaml:
##########
@@ -0,0 +1,42 @@
+# 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.
+
+name: Dead Link Checker
+
+on:
+ push:
+ paths:
+ - '**.md'
+ pull_request:
+ branches:
+ - master
+ - branch-*
+
+concurrency:
+ group: dlc-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ CheckDeadLinks:
Review Comment:
Thx, done
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] CalvinKirs commented on a diff in pull request #3269: Fix dead link and add CI check
Posted by GitBox <gi...@apache.org>.
CalvinKirs commented on code in PR #3269:
URL: https://github.com/apache/bookkeeper/pull/3269#discussion_r870951621
##########
.github/workflows/dead-link-checker.yaml:
##########
@@ -0,0 +1,36 @@
+# 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.
+
+name: Dead Link Checker
+
+on:
+ pull_request:
+
+concurrency:
+ group: dlc-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ CheckDeadLinks:
+ runs-on: ubuntu-latest
+ timeout-minutes: 30
Review Comment:
now,the check is only triggered when the MD file is modified
--
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.
To unsubscribe, e-mail: issues-unsubscribe@bookkeeper.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org