fix: install Sourcey where config imports can resolve it - #1
Draft
HelloWorldSagwa wants to merge 1 commit into
Draft
fix: install Sourcey where config imports can resolve it#1HelloWorldSagwa wants to merge 1 commit into
HelloWorldSagwa wants to merge 1 commit into
Conversation
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
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.
Summary
instead of globally
sourcey.config.tscan resolve itsdocumented
import { defineConfig, ... } from "sourcey"containing spaces remain intact
and verifies the generated HTML and search index
Problem
The action currently installs Sourcey globally and then runs
sourcey build.With Sourcey 3.6.5, the documented config-file usage fails before the build:
The CLI is available globally, but the TypeScript config is loaded from the
consumer repository and imports
sourcey. Installing the package in thatrepository makes the import resolvable from the config's module scope.
Verification
documented
sourcey.config.tsimportindex.htmlandsearch-index.jsonaction.ymland the smoke workflow as YAMLThe install uses
--no-save --package-lock=false, so it does not add Sourceyto the consumer's manifest or create/update a package lock. The generated docs
and
output-dircontract are unchanged.