Skip to content

Commit

Permalink
docs: Add section on running tests to contributing guide (#953)
Browse files Browse the repository at this point in the history
## Which problem is this PR solving?
Adds a section to the contributing guide to show to execute tests
locally.

## Short description of the changes
- Add test section to CONTRIBUTING.md
- Add asdf `.tools-version` file that sets the expected golang version
to 1.21.1
  • Loading branch information
MikeGoldsmith authored Dec 18, 2023
1 parent 78c832b commit 5eda8fb
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
1 change: 1 addition & 0 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
golang 1.21.1
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ at the root of the Refinery directory.

`go run ./cmd/refinery/main.go -c config_complete.yaml -r rules_complete.yaml`

# Running Refinery tests locally

Tests require a local installation of redis. See [here](https://redis.io/docs/install/install-stack) for how to get it running.

You can run Refinery tests by running the command below at the root of the Refinery directory.

`make test`

# Making changes to configuration code

With the new configuration format redesign in v2.0.0, the workflow for making a configuration requires the following steps:
Expand Down

0 comments on commit 5eda8fb

Please sign in to comment.