Skip to content

Commit

Permalink
docs(README): Document how to test an in-development version of Basep…
Browse files Browse the repository at this point in the history
…late in Snoodev (#756)
  • Loading branch information
KTAtkinson authored Nov 18, 2022
1 parent bc2d21f commit 3ebe86c
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,25 @@ actions on push.
Specific hooks can be [temporarily disabled](https://pre-commit.com/#temporarily-disabling-hooks).

You can install hooks only for a specific step (i.e. [pre-push](https://pre-commit.com/#pre-commit-during-push)).

## Testing in Snoodev

You can upgrade any service to use in development Baseplate code in Snoodev by
editing the requirements file for the service you would like to use for testing.
Update the the Baseplate requirement to pull from Github instead, like this:

```
diff --git a/requirements.txt b/requirements.txt
index aef8ad8..d32a078 100644
--- a/requirements.txt
+++ b/requirements.txt
-baseplate==2.5.7
+git+https://github.com/reddit/baseplate.py@<ref>#egg=baseplate
```

In this case the ref can be either a commit hash or a branch name. After making
this update you can check if the service works in Snoodev.

> **Warning**
> Never deploy this change to production. Production should always use a Baseplate
> semantic version that has been tagged, and released.

0 comments on commit 3ebe86c

Please sign in to comment.