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 2020/08/20 02:39:58 UTC
[GitHub] [trafficcontrol] ocket8888 opened a new pull request #4977: Added action to build documentation
ocket8888 opened a new pull request #4977:
URL: https://github.com/apache/trafficcontrol/pull/4977
## What does this PR (Pull Request) do?
- [x] This PR is not related to any Issue
This adds a GitHub Action to build documentation on every pull request that affects files in `docs/source/`. It outputs annotations on problem areas, and uploads a copy of the built documentation as a build artifact.
## Which Traffic Control components are affected by this PR?
- Documentation
- CI tests
## What is the best way to verify this PR?
Observe the check's output. I included some docs fixes that should cause the check to be run.
## The following criteria are ALL met by this PR
- [x] This is a test (sorta)
- [x] This PR builds documentation
- [x] This PR includes an update to CHANGELOG.md OR such an update is not necessary
- [x] This PR includes any and all required license headers
- [x] This PR does not include a database migration
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY**
----------------------------------------------------------------
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] mattjackson220 merged pull request #4977: Added action to build documentation
Posted by GitBox <gi...@apache.org>.
mattjackson220 merged pull request #4977:
URL: https://github.com/apache/trafficcontrol/pull/4977
----------------------------------------------------------------
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 #4977: Added action to build documentation
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4977:
URL: https://github.com/apache/trafficcontrol/pull/4977#discussion_r473623447
##########
File path: .github/workflows/docs.yml
##########
@@ -0,0 +1,44 @@
+# 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: Documentation Build
+
+on:
+ create:
+ push:
+ paths:
+ - docs/source/**
+ pull_request:
+ types: [opened, reopened, edited, synchronize]
+ paths:
+ - docs/source/**
Review comment:
The docs workflow should also run when anything in `traffic_control/clients/python/trafficops/` is modified (or maybe only `tosession.py`?) since it contains `:ref:`s to TO API endpoints, and if any of those are broken, you get a warning like
```python
trafficcontrol/traffic_control/clients/python/trafficops/tosession.py:docstring of trafficops.TOSession.an_endpoint_function:1: WARNING: undefined label: barfoo (if the link has no caption the label must precede a section header)
```
----------------------------------------------------------------
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 #4977: Added action to build documentation
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4977:
URL: https://github.com/apache/trafficcontrol/pull/4977#discussion_r474114060
##########
File path: .github/workflows/docs.yml
##########
@@ -0,0 +1,44 @@
+# 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: Documentation Build
+
+on:
+ create:
+ push:
+ paths:
+ - docs/source/**
+ pull_request:
+ types: [opened, reopened, edited, synchronize]
+ paths:
+ - docs/source/**
Review comment:
yeah, good point.
----------------------------------------------------------------
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