Skip to content

Commit

Permalink
Merge pull request #15 from newcontext-oss/contribution_update
Browse files Browse the repository at this point in the history
Update Contributing Guidelines with testing and release workflow.
  • Loading branch information
edwardbartholomew authored Mar 6, 2020
2 parents a8b7aa4 + 20e3e0d commit bc1872e
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,27 @@ The following command will execute the unit tests.
> Executing unit tests with Go's testing package
```sh
go test -v
go test -v ./...
```

The json files under [testdata](testdata) contain supporting json files for testing.

### Continuously Integrating and Continuously Deploying
GitHub Actions are used to provide continuous integration and continuous deployment functionality for this app.

The workflows are configured at .github/workflows/

Linting, static analysis via [Staticcheck][staticcheck], and unit tests will be executed for each commit to a branch as well as all pull requests.

If a commit to the master branch has a tag starting with a v, then the job will attempt to build the app and deploy it as a [release][release].

<!-- Markdown links and image definitions -->
[credhub]: https://docs.cloudfoundry.org/credhub/
[fork-a-repo]: https://help.github.com/articles/fork-a-repo/
[github-issue-tracker]: https://github.com/newcontext-oss/credhub-venafi/issues
[go]: https://golang.org/
[gotest]: https://golang.org/pkg/testing
[release]: https://github.com/newcontext-oss/credhub-venafi/releases
[staticcheck]: https://staticcheck.io/
[testdata]: https://github.com/newcontext-oss/credhub-venafi/tree/master/testdata
[venafi]: https://venafi.com

0 comments on commit bc1872e

Please sign in to comment.