Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add missing step for llhttp update #44136

Closed
wants to merge 1 commit into from

Conversation

mhdawson
Copy link
Member

@mhdawson mhdawson commented Aug 4, 2022

Refs: #43946

  • Add instructions on updating llhttp version in
    file maintained only in Node.js repository as it
    needs to be kept in sync with what is copied from
    the llhttp repository when an update is made.

Signed-off-by: Michael Dawson mdawson@devrus.com

Refs: nodejs#43946

- Add instructions on updating llhttp version in
  file maintained only in Node.js repository as it
  needs to be kept in sync with what is copied from
  the llhttp repository when an update is made.

Signed-off-by: Michael Dawson <mdawson@devrus.com>
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Aug 4, 2022
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Comment on lines +90 to +91
* update the llhttp version number in the project line in CMakeLists.txt
to match that set in include/llhttp.h
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm surprised we need to do this. AFAICT this should have been updated in the make release step from llhttp: https://github.com/nodejs/llhttp/blob/da60b0bb00b46f0ac58ea48506c6fb6c1b5c112c/Makefile#L54
which should write an updated version of https://github.com/nodejs/llhttp/blob/main/CMakeLists.txt into the release directory.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah the TAG stuff looks new nodejs/llhttp#170.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That does makes sense. If that will be auto updated then we won't need this update. @mcollina is that correct?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mcollina, ping?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mcollina ping ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the step that need to change is line 86.

From
* run `make release` in the directory that you checked out llhttp.
to (manually)
* run `TAG=<version> make release` in the directory that you checked out llhttp.
or (automatic)
* run ``TAG=`node -e \"process.stdout.write(require('./package').version)\"` make release`` in the directory that you checked out llhttp.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The thing is that if llhttp is properly released and downloaded this should not be done at all. Whoever is importing llhttp should just download it from GitHub and copy over.

Let me figure it out.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The thing is that if llhttp is properly released and downloaded this should not be done at all.

If the step is about downloading, which will be the tag release/vx.y.z.
For example, https://github.com/nodejs/llhttp/releases/tag/release%2Fv6.0.9

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly. One should not have to download llhttp source and compile locally since we release from GitHub now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Side node: I've just updated llhttp to require the RELEASE variable when running releases command manually, so now CMakeList.txt, llhttp.h and package.json should all report the same version.

Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this isn't resolved otherwise.

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mhdawson
Copy link
Member Author

@ShogunPanda, I'll try to pull the suggestions from another thread into this PR sometime this week so we can get it landed.

@ShogunPanda
Copy link
Contributor

@mhdawson Please see #44652, it should replace this PR.

@mhdawson
Copy link
Member Author

@ShogunPanda thanks, closing this one.

@mhdawson mhdawson closed this Sep 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants