Conversation
mtuchi
force-pushed
the
unit-testing
branch
from
September 16, 2026 09:19
b979a72 to
9de701b
Compare
PiusKariuki
reviewed
Sep 16, 2026
PiusKariuki
reviewed
Sep 16, 2026
PiusKariuki
left a comment
PiusKariuki
left a comment
Contributor
There was a problem hiding this comment.
This is so good @mtuchi . I have just one minor comment for you.
josephjclark
requested changes
Sep 17, 2026
josephjclark
left a comment
josephjclark
left a comment
Collaborator
There was a problem hiding this comment.
AI isn't ready to write out docsite yet.
I don't like it. The more closely I read this the more problems I find :(
I think I'd rather have a really short, concise guide to unit testing which doesn't have all this explanation. It's long and repetetive and confusing - I'm not convinced we need 500 lines of this.
Contributor
Author
|
Hiya @josephjclark i have cut down lots of verbose stuff, please have another look |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Short Description
Adds a new docs page, "Writing unit tests for your jobs", covering how to compile job code with
openfn compile --exports-onlyand test the helper functions with a standard JavaScript test runner. Cross-linked from the job writing guide and the two CLI pages.Closes #840
Details
docs/jobs/unit-testing-jobs.md, added to the sidebar under Write Jobs, afterjobs/compilationdocs/jobs/job-writing-guide.mdpicks up a short "your helpers can be unit tested" pointer in Next Stepsdocs/build-for-developers/cli-intro.mdgains a bullet in the "you can use the OpenFn CLI to..." listdocs/build-for-developers/cli-usage.mdgains a "Compile job code for unit testing" sectionWalk through video
AI Usage
You can read more details in our
Responsible AI Policy