add readme to publishBody #5374
Merged
Conversation
This file contains 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
hindicator
commented
Apr 7, 2023
| @@ -0,0 +1,48 @@ | |||
| import {httpUtils} from '@yarnpkg/core'; | |||
There was a problem hiding this comment.
Few things that would really help me -
- About tests :
- I have two ideas how to implement:
- e2e test with
makeTemporaryEnv, spyOnnpmHttpUtils.putand expect to be called with body that contain readme. - unit test and builders, build required params for
makePublishBodyaka
workspace: Workspace, buffer: Buffer, {access, tag, registry, gitHead}: PublishAdditionalParams
such as inside builders.ts
export function aWorkspace(): Workspace{}
and just call this function.
I think the first option is better but I can't seem to succeed implement a spyOn.
any suggestions ?
- I believe
readmeFilenameis deprecated but -
see this -
json:readmeFilenamenpm/npm#3573 (comment)
and this -
Set readmeFilename field on root metadata npm/cli#4252
Do you think we need to add this ?
There was a problem hiding this comment.
Also should add test for workspace(monorepo) as the readme file is read with cwd,
I don't know if cwd is relative when using yarn workspaces foreach npm publish
merceyz
pushed a commit
that referenced
this pull request
May 16, 2023
* add readme to publishBody * clean test with example * add fallback to project name * cleaning * fix getPublishAccess * cleaning * remove unused parameter * Tweaks * Tweaks tests * Versions * Update publish.test.ts --------- Co-authored-by: Maël Nison <[email protected]>
merceyz
pushed a commit
that referenced
this pull request
May 16, 2023
* add readme to publishBody * clean test with example * add fallback to project name * cleaning * fix getPublishAccess * cleaning * remove unused parameter * Tweaks * Tweaks tests * Versions * Update publish.test.ts --------- Co-authored-by: Maël Nison <[email protected]>
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.
What's the problem this PR addresses?
Add readme field to publish body so registry would pull this.
How did you fix it?
Read the
README.mdfile from currentDir and add to publish body.Checklist