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

docs(README): Document how to test an in-development version of Baseplate in Snoodev #756

Merged
merged 3 commits into from
Nov 18, 2022
Merged

docs(README): Document how to test an in-development version of Baseplate in Snoodev #756

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f910630
docs(README): Document how to test an in-development version of Basep…
KTAtkinson Oct 20, 2022
8e9ff5d
Apply suggestions from code review
KTAtkinson Oct 20, 2022
ccee37b
Update README.md
KTAtkinson Nov 2, 2022
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
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
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
Copy link
Contributor

Choose a reason for hiding this comment

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

🔕 Not against it here, and these instructions seem fine, but seems a little strange to me for this to be here but testing sidecars to be in the wiki

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note that talks about how to release sidecars and then test them, not how to test them locally. Also currently this approach doesn't work with sidecars.

Copy link
Member

Choose a reason for hiding this comment

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

🔕 nit: Multiple top-level headings in the same document

KTAtkinson marked this conversation as resolved.
Show resolved Hide resolved

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**
Copy link
Contributor

Choose a reason for hiding this comment

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

TIL markdown syntax formats this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had to look it up :D

> Never deploy this change to production. Production should always use a Baseplate
> version that has been released and published to pypi.
KTAtkinson marked this conversation as resolved.
Show resolved Hide resolved