From ae6cd92101296ec5334b10da64f0ae25f701e909 Mon Sep 17 00:00:00 2001 From: "Matt Moore (via Sockpuppet)" Date: Fri, 25 Sep 2020 01:24:04 +0000 Subject: [PATCH 1/2] Update common github actions Signed-off-by: Matt Moore (via Sockpuppet) --- .github/workflows/knative-boilerplate.yaml | 96 +++++++++ .github/workflows/knative-donotsubmit.yaml | 61 ++++++ .github/workflows/knative-go-build.yaml | 59 ++++++ .github/workflows/knative-go-test.yaml | 65 ++++++ .github/workflows/knative-stale.yaml | 49 +++++ .github/workflows/knative-style.yaml | 228 +++++++++++++++++++++ .github/workflows/knative-verify.yaml | 75 +++++++ 7 files changed, 633 insertions(+) create mode 100644 .github/workflows/knative-boilerplate.yaml create mode 100644 .github/workflows/knative-donotsubmit.yaml create mode 100644 .github/workflows/knative-go-build.yaml create mode 100644 .github/workflows/knative-go-test.yaml create mode 100644 .github/workflows/knative-stale.yaml create mode 100644 .github/workflows/knative-style.yaml create mode 100644 .github/workflows/knative-verify.yaml diff --git a/.github/workflows/knative-boilerplate.yaml b/.github/workflows/knative-boilerplate.yaml new file mode 100644 index 0000000000..f79d4401bb --- /dev/null +++ b/.github/workflows/knative-boilerplate.yaml @@ -0,0 +1,96 @@ +# Copyright 2020 The Knative Authors. +# +# 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. + +# This file is automagically synced here from github.com/knative-sandbox/.github +# repo by knobots: https://github.com/mattmoor/knobots and will be overwritten. + +name: Boilerplate + +on: + pull_request: + branches: [ 'master', 'release-*' ] + +jobs: + + check: + name: Boilerplate Check + runs-on: ubuntu-latest + strategy: + fail-fast: false # Keep running if one leg fails. + matrix: + extension: + - go + - sh + + # Map between extension and human-readable name. + include: + - extension: go + language: Go + - extension: sh + language: Bash + + steps: + + - name: Set up Go 1.15.x + uses: actions/setup-go@v2 + with: + go-version: 1.15.x + id: go + + - name: Check out code + uses: actions/checkout@v2 + + - name: Install Tools + run: | + TEMP_PATH="$(mktemp -d)" + cd $TEMP_PATH + + echo '::group::🐶 Installing reviewdog ... https://github.com/reviewdog/reviewdog' + curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b "${TEMP_PATH}" 2>&1 + echo '::endgroup::' + + echo '::group:: Installing boilerplate-check ... https://github.com/mattmoor/boilerplate-check' + go get github.com/mattmoor/boilerplate-check/cmd/boilerplate-check + echo '::endgroup::' + + echo "::add-path::${TEMP_PATH}" + + - id: boilerplate_txt + uses: andstor/file-existence-action@v1 + with: + files: ./hack/boilerplate/boilerplate.${{ matrix.extension }}.txt + - name: ${{ matrix.language }} license boilerplate + shell: bash + if: ${{ steps.boilerplate_txt.outputs.files_exists == 'true' }} + env: + REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }} + run: | + set -e + cd "${GITHUB_WORKSPACE}" || exit 1 + + echo '::group:: Running github.com/mattmoor/boilerplate-check for ${{ matrix.language }} with reviewdog 🐶 ...' + # Don't fail because of boilerplate-check + set +o pipefail + boilerplate-check check \ + --boilerplate ./hack/boilerplate/boilerplate.${{ matrix.extension }}.txt \ + --file-extension ${{ matrix.extension }} \ + --exclude "(vendor|third_party)/" | + reviewdog -efm="%A%f:%l: %m" \ + -efm="%C%.%#" \ + -name="${{ matrix.language }} headers" \ + -reporter="github-pr-check" \ + -filter-mode="diff_context" \ + -fail-on-error="true" \ + -level="error" + echo '::endgroup::' diff --git a/.github/workflows/knative-donotsubmit.yaml b/.github/workflows/knative-donotsubmit.yaml new file mode 100644 index 0000000000..92a96636ba --- /dev/null +++ b/.github/workflows/knative-donotsubmit.yaml @@ -0,0 +1,61 @@ +# Copyright 2020 The Knative Authors. +# +# 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. + +# This file is automagically synced here from github.com/knative-sandbox/.github +# repo by knobots: https://github.com/mattmoor/knobots and will be overwritten. + +name: Do Not Submit + +on: + pull_request: + branches: [ 'master', 'release-*' ] + +jobs: + + donotsubmit: + name: Do Not Submit + runs-on: ubuntu-latest + + steps: + - name: Check out code + uses: actions/checkout@v2 + + - name: Do Not Submit + shell: bash + env: + REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }} + run: | + set -e + cd "${GITHUB_WORKSPACE}" || exit 1 + + TEMP_PATH="$(mktemp -d)" + PATH="${TEMP_PATH}:$PATH" + + echo '::group::🐶 Installing reviewdog ... https://github.com/reviewdog/reviewdog' + curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b "${TEMP_PATH}" 2>&1 + echo '::endgroup::' + + echo '::group:: Running DO NOT SUBMIT with reviewdog 🐶 ...' + # Don't fail because of grep + set +o pipefail + find . -type f -not -path './vendor/*' -not -path './third_party/*' -not -path './.git/*' -not -path './.github/workflows/*' | + xargs grep -n "DO NOT SUBMIT" | + reviewdog -efm="%f:%l:%m" \ + -name="DO NOT SUBMIT" \ + -reporter="github-pr-check" \ + -filter-mode="added" \ + -fail-on-error="true" \ + -level="error" + + echo '::endgroup::' diff --git a/.github/workflows/knative-go-build.yaml b/.github/workflows/knative-go-build.yaml new file mode 100644 index 0000000000..609551157f --- /dev/null +++ b/.github/workflows/knative-go-build.yaml @@ -0,0 +1,59 @@ +# Copyright 2020 The Knative Authors. +# +# 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. + +# This file is automagically synced here from github.com/knative-sandbox/.github +# repo by knobots: https://github.com/mattmoor/knobots and will be overwritten. + +name: Build + +on: + pull_request: + branches: [ 'master', 'release-*' ] + +jobs: + + build: + name: Build + strategy: + matrix: + go-version: [1.15.x] + platform: [ubuntu-latest] + + runs-on: ${{ matrix.platform }} + + steps: + + - name: Set up Go ${{ matrix.go-version }} + uses: actions/setup-go@v2 + with: + go-version: ${{ matrix.go-version }} + id: go + + - name: Check out code + uses: actions/checkout@v2 + + - name: Build + run: | + tags="$(grep -I -r '// +build' . | \ + grep -v '^./vendor/' | \ + grep -v '^./hack/' | \ + grep -v '^./third_party' | \ + cut -f3 -d' ' | \ + sort | uniq | \ + grep -v '^!' | \ + tr '\n' ' ')" + + echo "Building with tags: ${tags}" + go test -vet=off -tags "${tags}" -run=^$ ./... | grep -v "no test" || true + diff --git a/.github/workflows/knative-go-test.yaml b/.github/workflows/knative-go-test.yaml new file mode 100644 index 0000000000..bfe6c6ad29 --- /dev/null +++ b/.github/workflows/knative-go-test.yaml @@ -0,0 +1,65 @@ +# Copyright 2020 The Knative Authors. +# +# 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. + +# This file is automagically synced here from github.com/knative-sandbox/.github +# repo by knobots: https://github.com/mattmoor/knobots and will be overwritten. + +name: Test + +on: + + push: + branches: [ 'master' ] + + pull_request: + branches: [ 'master', 'release-*' ] + +jobs: + + test: + name: Unit Tests + strategy: + matrix: + go-version: [1.15.x] + platform: [ubuntu-latest] + + runs-on: ${{ matrix.platform }} + + steps: + + - name: Set up Go ${{ matrix.go-version }} + uses: actions/setup-go@v2 + with: + go-version: ${{ matrix.go-version }} + id: go + + - name: Check out code + uses: actions/checkout@v2 + + - name: Check for .codecov.yaml + id: codecov-enabled + uses: andstor/file-existence-action@v1 + with: + files: .codecov.yaml + + - if: steps.codecov-enabled.outputs.files_exists == 'true' + name: Produce Go Coverage + run: echo '::set-env name=COVER_OPTS::-coverprofile=coverage.txt -covermode=atomic' + + - name: Test + run: go test -race $COVER_OPTS ./... + + - if: steps.codecov-enabled.outputs.files_exists == 'true' + name: Codecov + uses: codecov/codecov-action@v1 diff --git a/.github/workflows/knative-stale.yaml b/.github/workflows/knative-stale.yaml new file mode 100644 index 0000000000..1b4e4334b1 --- /dev/null +++ b/.github/workflows/knative-stale.yaml @@ -0,0 +1,49 @@ +# Copyright 2020 The Knative Authors. +# +# 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. + +# This file is automagically synced here from github.com/knative-sandbox/.github +# repo by knobots: https://github.com/mattmoor/knobots and will be overwritten. + +name: 'Close stale' + +on: + schedule: + - cron: '0 1 * * *' + +jobs: + stale: + runs-on: 'ubuntu-latest' + steps: + - uses: 'actions/stale@v3' + with: + repo-token: '${{ secrets.GITHUB_TOKEN }}' # No need to setup + + stale-issue-message: |- + This issue is stale because it has been open for 90 days with no + activity. It will automatically close after 30 more days of + inactivity. Reopen the issue with `/reopen`. Mark the issue as + fresh by adding the comment `/remove-lifecycle stale`. + stale-issue-label: 'lifecycle/stale' + exempt-issue-labels: 'lifecycle/frozen' + + stale-pr-message: |- + This Pull Request is stale because it has been open for 90 days with + no activity. It will automatically close after 30 more days of + inactivity. Reopen with `/reopen`. Mark as fresh by adding the + comment `/remove-lifecycle stale`. + stale-pr-label: 'lifecycle/stale' + exempt-pr-labels: 'lifecycle/frozen' + + days-before-stale: 90 + days-before-close: 30 diff --git a/.github/workflows/knative-style.yaml b/.github/workflows/knative-style.yaml new file mode 100644 index 0000000000..31a0aeb2ee --- /dev/null +++ b/.github/workflows/knative-style.yaml @@ -0,0 +1,228 @@ +# Copyright 2020 The Knative Authors. +# +# 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. + +# This file is automagically synced here from github.com/knative-sandbox/.github +# repo by knobots: https://github.com/mattmoor/knobots and will be overwritten. + +name: Code Style + +on: + pull_request: + branches: [ 'master', 'release-*' ] + +jobs: + + autoformat: + name: Auto-format and Check + runs-on: ubuntu-latest + + steps: + + - name: Set up Go 1.15.x + uses: actions/setup-go@v2 + with: + go-version: 1.15.x + id: go + + - name: Check out code + uses: actions/checkout@v2 + + - name: Install Dependencies + run: | + cd $(mktemp -d) + GO111MODULE=on go get golang.org/x/tools/cmd/goimports + + # Run this last because it alters the workspace. + # TODO: add prettier step + - name: Go Imports + shell: bash + run: | + goimports -w $(find -path './vendor' -prune -o -path './third_party' -prune -o -name '*.pb.go' -prune -o -type f -name '*.go' -print) + echo "::set-env name=FMT_TOOL::goimports" + - name: Verify goimport + shell: bash + run: | + if [[ $(git diff-index --name-only HEAD --) ]]; then + echo "Found diffs in:" + git diff-index --name-only HEAD -- + echo "${{ github.repository }} is out of style. Please run $FMT_TOOL." + exit 1 + fi + echo "${{ github.repository }} is formatted correctly." + + - name: Go Format + shell: bash + run: | + gofmt -s -w $(find -path './vendor' -prune -o -path './third_party' -prune -o -name '*.pb.go' -prune -o -type f -name '*.go' -print) + echo "::set-env name=FMT_TOOL::gofmt" + - name: Verify gofmt + shell: bash + # TODO(mattmoor): combine with above via anchors when actions support it. + run: | + if [[ $(git diff-index --name-only HEAD --) ]]; then + echo "Found diffs in:" + git diff-index --name-only HEAD -- + echo "${{ github.repository }} is out of style. Please run $FMT_TOOL." + exit 1 + fi + echo "${{ github.repository }} is formatted correctly." + + lint: + name: Lint + runs-on: ubuntu-latest + + steps: + - name: Set up Go 1.15.x + uses: actions/setup-go@v2 + with: + go-version: 1.15.x + id: go + + - name: Check out code + uses: actions/checkout@v2 + + - name: Install Tools + run: | + TEMP_PATH="$(mktemp -d)" + cd $TEMP_PATH + + echo '::group::🐶 Installing reviewdog ... https://github.com/reviewdog/reviewdog' + curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b "${TEMP_PATH}" 2>&1 + echo '::endgroup::' + + echo '::group:: Installing misspell ... https://github.com/client9/misspell' + go get github.com/client9/misspell/cmd/misspell + echo '::endgroup::' + + echo '::group:: Installing woke ... https://github.com/get-woke/woke' + curl -sfL https://raw.githubusercontent.com/get-woke/woke/main/install.sh | sh -s -- -b "${TEMP_PATH}" "${WOKE_VERSION}" 2>&1 + echo '::endgroup::' + + echo "::add-path::${TEMP_PATH}" + + - id: golangci_configuration + uses: andstor/file-existence-action@v1 + with: + files: .golangci.yaml + - name: Go Lint + if: steps.golangci_configuration.outputs.files_exists == 'true' + uses: golangci/golangci-lint-action@v2 + with: + version: v1.30 + only-new-issues: true # for initial defensiveness + + - name: misspell + shell: bash + if: ${{ always() }} + env: + REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }} + run: | + set -e + cd "${GITHUB_WORKSPACE}" || exit 1 + + echo '::group:: Running github.com/client9/misspell with reviewdog 🐶 ...' + # Don't fail because of misspell + set +o pipefail + find . -type f -not -path './vendor/*' -not -path './third_party/*' -not -path './.git/*' | + xargs misspell -error | + reviewdog -efm="%f:%l:%c: %m" \ + -name="github.com/client9/misspell" \ + -reporter="github-pr-check" \ + -filter-mode="added" \ + -fail-on-error="true" \ + -level="error" + + echo '::endgroup::' + + - name: trailing whitespace + shell: bash + if: ${{ always() }} + env: + REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }} + run: | + set -e + cd "${GITHUB_WORKSPACE}" || exit 1 + + echo '::group:: Flagging trailing whitespace with reviewdog 🐶 ...' + # Don't fail because of grep + set +o pipefail + find . -type f -not -path './vendor/*' -not -path './third_party/*' -not -path './.git/*' | + xargs grep -nE " +$" | + reviewdog -efm="%f:%l:%m" \ + -name="trailing whitespace" \ + -reporter="github-pr-check" \ + -filter-mode="added" \ + -fail-on-error="true" \ + -level="error" + + echo '::endgroup::' + + - name: EOF newline + shell: bash + if: ${{ always() }} + env: + REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }} + run: | + set -e + cd "${GITHUB_WORKSPACE}" || exit 1 + + echo '::group:: Flagging missing EOF newlines with reviewdog 🐶 ...' + # Don't fail because of misspell + set +o pipefail + for x in $(find . -type f -not -path './vendor/*' -not -path './third_party/*' -not -path './.git/*'); do + # Based on https://stackoverflow.com/questions/34943632/linux-check-if-there-is-an-empty-line-at-the-end-of-a-file + if [[ -f $x && ! ( -s "$x" && -z "$(tail -c 1 $x)" ) ]]; then + # We add 1 to `wc -l` here because of this limitation (from the man page): + # Characters beyond the final character will not be included in the line count. + echo $x:$((1 + $(wc -l $x | tr -s ' ' | cut -d' ' -f 1))): Missing newline + fi + done | + reviewdog -efm="%f:%l: %m" \ + -name="EOF Newline" \ + -reporter="github-pr-check" \ + -filter-mode="added" \ + -fail-on-error="true" \ + -level="error" + + echo '::endgroup::' + + # This is mostly copied from https://github.com/get-woke/woke-action-reviewdog/blob/main/entrypoint.sh + # since their action is not yet released under a stable version. + - name: Language + if: ${{ always() && github.event_name == 'pull_request' }} + shell: bash + env: + REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }} + WOKE_VERSION: v0.1.11 + run: | + set -e + cd "${GITHUB_WORKSPACE}" || exit 1 + + # Create a minimal .wokeignore if none already exist. + if [ ! -f .wokeignore ]; then + cat > .wokeignore < Date: Thu, 24 Sep 2020 18:49:37 -0700 Subject: [PATCH 2/2] Run gofmt --- pkg/build/gobuild_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/build/gobuild_test.go b/pkg/build/gobuild_test.go index 9456a00685..a241449c07 100644 --- a/pkg/build/gobuild_test.go +++ b/pkg/build/gobuild_test.go @@ -80,7 +80,7 @@ func TestGoBuildIsSupportedRefWithModules(t *testing.T) { Dir: ".", }, deps: map[string]*modInfo{ - "github.com/some/module/cmd": &modInfo{ + "github.com/some/module/cmd": { Path: "github.com/some/module/cmd", Dir: ".", },