Adding github workflow to render docs and lint #848
Conversation
|
Strange, I don't see the CI running here. Should I re-open a PR on my own branch and we can discuss over there? |
|
The test command running locally (and in my repo CI) has this error - the one I'm suspecting means that I need to do some change to a path (e.g., GOPATH) or install differently: $ go test $(go list ./... | grep -v /vendor/)
can't load package: package _/home/vanessa/Desktop/Code/image-spec/identity: cannot find package "_/home/vanessa/Desktop/Code/image-spec/identity" in any of:
/usr/local/go/src/_/home/vanessa/Desktop/Code/image-spec/identity (from $GOROOT)
/home/vanessa/Desktop/Code/go/src/_/home/vanessa/Desktop/Code/image-spec/identity (from $GOPATH)
/home/vanessa/Desktop/Code/image-spec/src/_/home/vanessa/Desktop/Code/image-spec/identity
can't load package: package _/home/vanessa/Desktop/Code/image-spec/schema: cannot find package "_/home/vanessa/Desktop/Code/image-spec/schema" in any of:
/usr/local/go/src/_/home/vanessa/Desktop/Code/image-spec/schema (from $GOROOT)
/home/vanessa/Desktop/Code/go/src/_/home/vanessa/Desktop/Code/image-spec/schema (from $GOPATH)
/home/vanessa/Desktop/Code/image-spec/src/_/home/vanessa/Desktop/Code/image-spec/schema
can't load package: package _/home/vanessa/Desktop/Code/image-spec/specs-go: cannot find package "_/home/vanessa/Desktop/Code/image-spec/specs-go" in any of:
/usr/local/go/src/_/home/vanessa/Desktop/Code/image-spec/specs-go (from $GOROOT)
/home/vanessa/Desktop/Code/go/src/_/home/vanessa/Desktop/Code/image-spec/specs-go (from $GOPATH)
/home/vanessa/Desktop/Code/image-spec/src/_/home/vanessa/Desktop/Code/image-spec/specs-go
can't load package: package _/home/vanessa/Desktop/Code/image-spec/specs-go/v1: cannot find package "_/home/vanessa/Desktop/Code/image-spec/specs-go/v1" in any of:
/usr/local/go/src/_/home/vanessa/Desktop/Code/image-spec/specs-go/v1 (from $GOROOT)
/home/vanessa/Desktop/Code/go/src/_/home/vanessa/Desktop/Code/image-spec/specs-go/v1 (from $GOPATH)
/home/vanessa/Desktop/Code/image-spec/src/_/home/vanessa/Desktop/Code/image-spec/specs-go/v1That approach does seem to be suggested by internet wisdom: https://stackoverflow.com/questions/16353016/how-to-go-test-all-tests-in-my-project |
|
There seems to be something funky going on with your
I don't think you can create and run an action in a PR, the action needs to already exist on the main branch -- you might need to test it on your branch and then get us to go review it there. |
|
Okay I finally have it working - I had to figure out the structure of the GitHub actions workspace, and then be a little more pendantic about paths. I wound up cloning the repository to where it should be in a gopath, a relative path at I added the docs "output" folder to save as an artifact. It's not as good at CircleCI artifacts that you can preview, but it's better than nothing! Here are the successful checks: https://github.com/vsoch/image-spec/pull/2/checks. There is detail work that could be done (e.g., more recent go versions, updating the latex container, adding better docs about building locally) but this should be a good skeleton to start. |
|
oh nice! lemme review that now |
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| go: ['1.10', '1.11', '1.12'] |
There was a problem hiding this comment.
these old versions are fine for first pass at parity. We can add the newer golang versions later
| GOPATH: /home/runner/work/image-spec/image-spec/go | ||
| run: | | ||
| export PATH=$GOPATH/bin:$PATH | ||
| docker pull quay.io/oci/pandoc:1.17.0.3-2.fc25.x86_64 |
There was a problem hiding this comment.
we'll have to remember to change this to the new image (https://github.com/opencontainers/distribution-spec/blob/main/Makefile#L11) once #846 merges
There was a problem hiding this comment.
yep I saw that! If someone doesn't beat me to it, I'll follow #846 and can come back and PR to update the image in this workflow.
| ifdef TRAVIS_COMMIT_RANGE | ||
| git-validation -q -run DCO,short-subject,dangling-whitespace | ||
| ifdef GITHUB_SHA | ||
| git-validation -q -run DCO,short-subject,dangling-whitespace -range $(GITHUB_SHA)..HEAD |
There was a problem hiding this comment.
ah, this ought to be tracked in git-validation.
vbatts/git-validation#48
| path: go/src/github.com/opencontainers/image-spec | ||
|
|
||
| # commit for v1 release | ||
| - uses: actions/setup-go@0caeaed6fd66a828038c2da3c0f662a42862658f |
There was a problem hiding this comment.
wait, this isn't for the image-spec v1, but some github action's release?
There was a problem hiding this comment.
Yes, I am using the full commit because it’s safer than even a tag or release. https://github.community/t/are-github-actions-safe-to-use/17895/2
| docker pull quay.io/oci/pandoc:1.17.0.3-2.fc25.x86_64 | ||
| cd go/src/github.com/opencontainers/image-spec | ||
| make install.tools | ||
| go get -u github.com/alecthomas/gometalinter |
There was a problem hiding this comment.
seems like this could just be moved into its own install.gometalinter target
There was a problem hiding this comment.
The goal was to reproduce the current CI, and making this call directly is exactly what it does:
Line 18 in 450f12c
This should be equivalent to the .travis-ci workflow, but run in GitHub actions. I am using the exact commit of the v1 release, as that is considered safer practice than the tag/release itself. Signed-off-by: vsoch <[email protected]>
|
LGTM |
This is almost all of the way there - the previous command to run tests does not work, and I suspect it's an issue with the path, or the install command (if anyone has insight that might take a look)!
In summary, this should be equivalent to the .travis-ci workflow, but run in GitHub actions. A few details:
-I am using the exact commit of the v1 release to install Go, as that is considered safer practice than the tag/release itself.
Signed-off-by: vsoch [email protected]