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/10/27 19:18:14 UTC
[GitHub] [trafficcontrol] zrhoffman opened a new pull request #6316: License coverage GHA: Re-tidy pkgsite's go modules before vendoring them
zrhoffman opened a new pull request #6316:
URL: https://github.com/apache/trafficcontrol/pull/6316
<!--
Thank you for contributing! Please be sure to read our contribution guidelines: https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md
If this closes or relates to an existing issue, please reference it using one of the following:
Closes: #ISSUE
Related: #ISSUE
If this PR fixes a security vulnerability, DO NOT submit! Instead, contact
the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
This PR revendors the golang.org/x/pkgsite dependencies for our project's major Go version (currently `1.17`).
Without this PR, the * License File Coverage Check for pkg.go.dev* action fails due to vendoring the Go 1.16 /x/ packages:
```go
internal/licenses/licenses.go:26:2: cannot find package "." in:
/home/runner/work/trafficcontrol/trafficcontrol/src/golang.org/x/pkgsite/vendor/io/fs
```
<!-- **^ Add meaningful description above** --><hr>
## Which Traffic Control components are affected by this PR?
<!-- Please delete all components from this list that are NOT affected by this PR.
Feel free to add the name of a tool or script that is affected but not on the list.
-->
- Automation (GitHub Actions)<!-- Please specify which (GitHub Actions, Docker images, Ansible Roles, etc.) -->
## What is the best way to verify this PR?
<!-- Please include here ALL the steps necessary to test your PR.
If your PR has tests (and most should), provide the steps needed to run the tests.
If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
Check if the *License File Coverage Check for pkg.go.dev* GHA workflow passes or fails for a good reason
## If this is a bugfix, which Traffic Control versions contained the bug?
<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
Examples:
- 5.1.2
- 5.1.3 (RC1)
-->
- 6.0.0
- master (e2ba960871)
## PR submission checklist
- [x] This PR has tests <!-- If not, please delete this text and explain why this PR does not need tests. -->
- [x] Bugfix, no documentation necessary <!-- If not, please delete this text and explain why this PR does not need documentation. -->
- [x] No changelog entry necessary <!-- A fix for a bug from an ATC release, an improvement, or a new feature should have a changelog entry. -->
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://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.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6316: License coverage GHA: Re-tidy pkgsite's go modules before vendoring them
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6316:
URL: https://github.com/apache/trafficcontrol/pull/6316#discussion_r737778313
##########
File path: .github/workflows/license-file-coverage.yml
##########
@@ -68,15 +69,22 @@ jobs:
uses: actions/cache@v2
with:
path: ${{ env.PKGSITE_DIR }}/vendor
- key: ${{ runner.os }}-go-${{ steps.go-version.outputs.value }}-${{ hashFiles('**/go.sum') }}-${{ hashFiles(format('{0}/{1}/{2}', env.PKGSITE_DIR, env.COVERAGE_TEST_NAME, format('{0}.go', env.COVERAGE_TEST_NAME))) }}
+ key: ${{ runner.os }}-go-${{ steps.go-version.outputs.value }}-tidy-${{ hashFiles('**/go.sum') }}-${{ hashFiles(format('{0}/{1}/{2}', env.PKGSITE_DIR, env.COVERAGE_TEST_NAME, format('{0}.go', env.COVERAGE_TEST_NAME))) }}
- name: Download Go modules for ${{ env.PKGSITE_REPO }}
run: |
- set -o errexit -o nounset -o xtrace
+ set -o errexit -o nounset -o xtrace -o pipefail
cd "$PKGSITE_DIR"
+ go_major_version_escaped="$(<<<"${{ steps.go-version.outputs.value }}" grep -Eo '^[0-9]+\.[0-9]+' | sed 's/\./\\\./g')"
if [[ ! -e vendor/modules.txt ]]; then
+ if ! grep -q "go ${go_major_version_escaped}" go.mod; then
+ echo 'Go version in go.mod does not match, tidying modules...'
Review comment:
Do we need this `echo` if we already have `xtrace` set? And actually I think the action would record what it runs even without the `xtrace`.
--
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@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #6316: License coverage GHA: Re-tidy pkgsite's go modules before vendoring them
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #6316:
URL: https://github.com/apache/trafficcontrol/pull/6316#discussion_r737782962
##########
File path: .github/workflows/license-file-coverage.yml
##########
@@ -68,15 +69,22 @@ jobs:
uses: actions/cache@v2
with:
path: ${{ env.PKGSITE_DIR }}/vendor
- key: ${{ runner.os }}-go-${{ steps.go-version.outputs.value }}-${{ hashFiles('**/go.sum') }}-${{ hashFiles(format('{0}/{1}/{2}', env.PKGSITE_DIR, env.COVERAGE_TEST_NAME, format('{0}.go', env.COVERAGE_TEST_NAME))) }}
+ key: ${{ runner.os }}-go-${{ steps.go-version.outputs.value }}-tidy-${{ hashFiles('**/go.sum') }}-${{ hashFiles(format('{0}/{1}/{2}', env.PKGSITE_DIR, env.COVERAGE_TEST_NAME, format('{0}.go', env.COVERAGE_TEST_NAME))) }}
- name: Download Go modules for ${{ env.PKGSITE_REPO }}
run: |
- set -o errexit -o nounset -o xtrace
+ set -o errexit -o nounset -o xtrace -o pipefail
cd "$PKGSITE_DIR"
+ go_major_version_escaped="$(<<<"${{ steps.go-version.outputs.value }}" grep -Eo '^[0-9]+\.[0-9]+' | sed 's/\./\\\./g')"
if [[ ! -e vendor/modules.txt ]]; then
+ if ! grep -q "go ${go_major_version_escaped}" go.mod; then
+ echo 'Go version in go.mod does not match, tidying modules...'
Review comment:
> Do we need this `echo` if we already have `xtrace` set?
Not really, it just makes the control flow more readable IMO
> And actually I think the action would record what it runs even without the `xtrace`.
It would print the commands that `run:` will run, but I don't think it would print the actual control flow without `xtrace`.
--
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@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6316: License coverage GHA: Re-tidy pkgsite's go modules before vendoring them
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6316:
URL: https://github.com/apache/trafficcontrol/pull/6316#discussion_r737788776
##########
File path: .github/workflows/license-file-coverage.yml
##########
@@ -68,15 +69,22 @@ jobs:
uses: actions/cache@v2
with:
path: ${{ env.PKGSITE_DIR }}/vendor
- key: ${{ runner.os }}-go-${{ steps.go-version.outputs.value }}-${{ hashFiles('**/go.sum') }}-${{ hashFiles(format('{0}/{1}/{2}', env.PKGSITE_DIR, env.COVERAGE_TEST_NAME, format('{0}.go', env.COVERAGE_TEST_NAME))) }}
+ key: ${{ runner.os }}-go-${{ steps.go-version.outputs.value }}-tidy-${{ hashFiles('**/go.sum') }}-${{ hashFiles(format('{0}/{1}/{2}', env.PKGSITE_DIR, env.COVERAGE_TEST_NAME, format('{0}.go', env.COVERAGE_TEST_NAME))) }}
- name: Download Go modules for ${{ env.PKGSITE_REPO }}
run: |
- set -o errexit -o nounset -o xtrace
+ set -o errexit -o nounset -o xtrace -o pipefail
cd "$PKGSITE_DIR"
+ go_major_version_escaped="$(<<<"${{ steps.go-version.outputs.value }}" grep -Eo '^[0-9]+\.[0-9]+' | sed 's/\./\\\./g')"
if [[ ! -e vendor/modules.txt ]]; then
+ if ! grep -q "go ${go_major_version_escaped}" go.mod; then
+ echo 'Go version in go.mod does not match, tidying modules...'
Review comment:
eh, it's not a big deal either way. It's directly in the workflow step, so its output isn't capturable by anything else, so if it's fine to look at in the GH logs then its fine.
--
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@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 merged pull request #6316: License coverage GHA: Re-tidy pkgsite's go modules before vendoring them
Posted by GitBox <gi...@apache.org>.
ocket8888 merged pull request #6316:
URL: https://github.com/apache/trafficcontrol/pull/6316
--
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@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org