You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2021/04/07 13:10:12 UTC
[GitHub] [trafficcontrol] zrhoffman opened a new pull request #5719: LICENSE file percent coverage GitHub Action
zrhoffman opened a new pull request #5719:
URL: https://github.com/apache/trafficcontrol/pull/5719
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
<!-- Explain the changes you made here. If this fixes an Issue, identify it by
replacing the text in the checkbox item with the Issue number e.g.
- [x] This PR fixes #9001 OR is not related to any Issue
^ This will automatically close Issue number 9001 when the Pull Request is
merged (The '#' is important).
Be sure you check the box properly, see the "The following criteria are ALL
met by this PR" section for details.
-->
Adds a GitHub Actions workflow to ensure that [our Godocs](https://pkg.go.dev/github.com/apache/trafficcontrol/lib/go-tc) will still show up after the LICENSE file is changed by checking whether the LICENSE file is at least 80% OSS licenses, according to [pkg.go.dev](https://pkg.go.dev/).
- [x] This PR is not related to any Issue<!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
## Which Traffic Control components are affected by this PR?
<!-- Please delete all components from this list that are NOT affected by this
Pull Request. Also, feel free to add the name of a tool or script that is
affected but not on the list.
Additionally, if this Pull Request does NOT affect documentation, please
explain why documentation is not required. -->
- Documentation
- Traffic Ops (technically changed, but only comments)
- CI tests
## What is the best way to verify this PR?
<!-- Please include here ALL the steps necessary to test your Pull Request. If
it includes tests (and most should), outline here the steps needed to run the
tests. If not, lay out the manual testing procedure and please explain why
tests are unnecessary for this Pull Request. -->
* Check the result of the *License File Coverage Check for pkg.go.dev* workflow
* Build and look at the docs
## The following criteria are ALL met by this PR
<!-- Check the boxes to signify that the associated statement is true. To
"check a box", replace the space inside of the square brackets with an 'x'.
e.g.
- [ x] <- Wrong
- [x ] <- Wrong
- [] <- Wrong
- [*] <- Wrong
- [x] <- Correct!
-->
- [x] This PR includes tests
- [x] This PR includes documentation
- [x] An update to CHANGELOG.md is not necessary
- [x] This PR includes any and all required license headers
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
<!--
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.
-->
--
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] [trafficcontrol] ocket8888 merged pull request #5719: LICENSE file percent coverage GitHub Action
Posted by GitBox <gi...@apache.org>.
ocket8888 merged pull request #5719:
URL: https://github.com/apache/trafficcontrol/pull/5719
--
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] [trafficcontrol] ocket8888 commented on a change in pull request #5719: LICENSE file percent coverage GitHub Action
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #5719:
URL: https://github.com/apache/trafficcontrol/pull/5719#discussion_r608730431
##########
File path: docs/source/development/godocs.rst
##########
@@ -0,0 +1,57 @@
+..
+..
+.. Licensed 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.
+..
+
+******
+Godocs
+******
+
+Linking to Godocs
+=================
+
+As mentioned in :ref:`docs-guide`, you can use the ``:docs-godoc:`` role, the ``:docs-atc-godoc:`` role, and the ``:docs-to-godoc:`` role to link to Godocs from the ATC documentation.
Review comment:
there's no `docs-` prefix on those roles
--
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] [trafficcontrol] zrhoffman commented on a change in pull request #5719: LICENSE file percent coverage GitHub Action
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #5719:
URL: https://github.com/apache/trafficcontrol/pull/5719#discussion_r608778109
##########
File path: docs/source/development/godocs.rst
##########
@@ -0,0 +1,57 @@
+..
+..
+.. Licensed 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.
+..
+
+******
+Godocs
+******
+
+Linking to Godocs
+=================
+
+As mentioned in :ref:`docs-guide`, you can use the ``:docs-godoc:`` role, the ``:docs-atc-godoc:`` role, and the ``:docs-to-godoc:`` role to link to Godocs from the ATC documentation.
Review comment:
Right you are, `docs-` prefix removed in 1b8cd21b82.
--
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