Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create GH Actions workflow for build&test of Go client #2318

Merged
merged 10 commits into from
Feb 10, 2021
Merged

Create GH Actions workflow for build&test of Go client #2318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8cc2e7e
Create GH Actions workflow for build&test of Go client
michalinacienciala Feb 4, 2021
ab6fdea
Change in a way of accessing tests results, improved readability
michalinacienciala Feb 8, 2021
e59dfd9
Modified conditions for workflow kick-off
michalinacienciala Feb 8, 2021
5affb78
Added possibility to trigger workflow manually
michalinacienciala Feb 8, 2021
372333d
Turned off publishing of test results in PR comments
michalinacienciala Feb 9, 2021
a368ae6
Modified incorrect naming of a step
michalinacienciala Feb 9, 2021
c41fb94
Temporary change to test reporting of test failures
michalinacienciala Feb 9, 2021
1947d44
Revert "Temporary change to test reporting of test failures"
michalinacienciala Feb 9, 2021
0504b8c
Simplified creation of test results directory
michalinacienciala Feb 10, 2021
8b9bd59
Highlighting piece of code covered by GitHub Actions workflow
michalinacienciala Feb 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ jobs:
root: /tmp/docs
paths:
- solidity/*
# GitHub Actions equivalent of this job (.github/workflows/client.yml) has been created as part of work on RFC-18
build_client_and_test_go:
executor: docker-git
steps:
Expand Down
42 changes: 42 additions & 0 deletions .github/workflows/client.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Go

#TODO: extend the conditions once workflow gets tested together with other workflows
on:
push:
branches:
- master
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thing that may be worth considering here, if we're continuing to run the Circle build, is to change this filter to run on certain branches (e.g. rfc-18/*) and change Circle to not run on that filter. This effectively gives you a branch namespace to use for the work.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Implemented in #2329

pull_request:
workflow_dispatch:

jobs:
build-and-test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: satackey/[email protected]
continue-on-error: true # ignore the failure of a step and avoid terminating the job
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll flag that the comment here mostly seems to be repeating what the flag already communicates (unlike if: always() which isn't as obvious).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. I'm not changing it though, as this fragment of code will be removed once #2331 gets merged to master.

- name: Run Docker build
run: |
docker build \
--target gobuild \
--tag go-build-env .
docker build \
--tag keep-client .
- name: Create test results directory
run: |
mkdir test-results
- name: Run Go tests
run: |
docker run \
--volume $GITHUB_WORKSPACE/test-results:/mnt/test-results \
--workdir /go/src/github.com/keep-network/keep-core \
go-build-env \
gotestsum --junitfile /mnt/test-results/unit-tests.xml
- name: Publish unit test results
uses: EnricoMi/[email protected]
if: always() # guarantees that this action always runs, even if earlier steps fail
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
files: ./test-results/unit-tests.xml
check_name: Go Test Results # name under which test results will be presented in GitHub (optional)
comment_on_pr: false # turns off commenting on Pull Requests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If things are working correctly, I believe the check should already be bubbling the important parts of this information up, including line annotations, e.g. like https://github.com/keep-network/keep-ecdsa/actions/runs/555260607 . I don't think we need the junit intermediary here, see https://github.com/actions/toolkit/blob/master/docs/commands.md#problem-matchers and the setup-go action's problem matcher at https://github.com/actions/setup-go/blob/main/matchers.json .

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Of note: we may want to add our own matcher that works with our go-to test output.)