wip: unit testing docs - #841
Draft
mtuchi wants to merge 1 commit into
Draft
Conversation
7 tasks
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
1 participant
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
What's here
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" sectionAI Usage
You can read more details in our
Responsible AI Policy