search

nodejs / node-core-test

Node 18's node:test, as an npm package
Other
95 stars 10 forks source link

Document update process #46

Open juliangruber opened 1 year ago

juliangruber commented 1 year ago

@MoLow I would like to update this repo from node core. What's your process for applying the patches, as in https://github.com/nodejs/node-core-test/pull/45?

MoLow commented 1 year ago

That is documented here: https://github.com/nodejs/node-core-test/wiki/How-this-repo-is-mantained

juliangruber commented 1 year ago

Awesome, thank you! I'll update today then

juliangruber commented 1 year ago

How do you deal with conflicts on the the docs, which live in different files?

$ git cherry-pick -x be4921474671fb15f0e62adfe2f37253d07eca02
CONFLICT (modify/delete): doc/api/test.md deleted in HEAD and modified in be49214746 (doc: fix test runner examples).  Version be49214746 (doc: fix test runner examples) of doc/api/test.md left in tree.
error: could not apply be49214746... doc: fix test runner examples
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
$ gs
On branch update-2023-03-15
You are currently cherry-picking commit be49214746.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
    deleted by us:   doc/api/test.md
MoLow commented 1 year ago

Sadly there is no easy way. I used manual comparison

juliangruber commented 1 year ago

What about we move the docs to doc/api/test.md for real, just include basic docs in the README (like install and a tiny example), and link to there? The ease of updating would be worth it to me