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

Documentation request: how to update files for a new node version #1190

Closed
clayzermk1 opened this issue Jan 10, 2020 · 7 comments
Closed

Documentation request: how to update files for a new node version #1190

clayzermk1 opened this issue Jan 10, 2020 · 7 comments

Comments

@clayzermk1
Copy link
Contributor

@clayzermk1 clayzermk1 commented Jan 10, 2020

A new stable node version was released. After looking at some previous PRs, digging through issues, looking at and playing with shell scripts, and reading all the docs in the repo, I can't figure out how to update the node versions besides doing it by hand. I know you all work hard to turn out new versions as soon as they come out, but I like to help where I can in FOSS-land, especially for tedious things like version changes.

Are there instructions for performing a node version update that I missed? Is that something you want the community's help with? I'd be more than happy to read a document, follow its instructions, and submit a PR for something routine like updating the repo for a new node version.

Cheers and thanks for the great tool!

@nschonni
Copy link
Member

@nschonni nschonni commented Jan 10, 2020

Don't think it's a documentation issue, just a bug #1161 (comment)

@PeterDaveHello
Copy link
Member

@PeterDaveHello PeterDaveHello commented Jan 10, 2020

Hi @clayzermk1,

Thanks for being interested in contribution to this project!

You're right that there is no documentation for the update process yet, actually we usually use the update.sh to do the job, it's usage can currently been revealed by the -h parameter, just as below:

~/FOSS/docker-node $ ./update.sh -h

  Update the node docker images.

  Usage:
    ./update.sh [-s] [MAJOR_VERSION(S)] [VARIANT(S)]

  Examples:
    - update.sh                   # Update all images
    - update.sh -s                # Update all images, skip updating Alpine and Yarn
    - update.sh 8,10              # Update version 8 and 10 and variants (default, slim, alpine etc.)
    - update.sh -s 8              # Update version 8 and variants, skip updating Alpine and Yarn
    - update.sh 8 slim,stretch    # Update only slim and stretch variants for version 8
    - update.sh -s 8 slim,stretch # Update only slim and stretch variants for version 8, skip updating Alpine and Yarn
    - update.sh . alpine          # Update the alpine variant for all versions
    - update.sh -t                # Update .travis.yml only

  OPTIONS:
    -s Security update; skip updating the yarn and alpine versions.
    -t Travis CI config update only
    -h Show this message

Would you like to try it and help us add some description in README.md? It'll be very helpful that somebody would like to help test the tools and add the missing document! Thank you!

@PeterDaveHello
Copy link
Member

@PeterDaveHello PeterDaveHello commented Jan 10, 2020

BTW, update.sh is once mentioned here in https://github.com/nodejs/docker-node/blob/master/CONTRIBUTING.md, but it's not a proper documentation for it.

@clayzermk1
Copy link
Contributor Author

@clayzermk1 clayzermk1 commented Jan 10, 2020

@PeterDaveHello I played with it but wasn't able to get it to modify any files - git showed no changes. If that's supposed to work then that's probably a different issue.

I'd be happy to add some documentation to the readme or maybe the contributing doc if a maintainer could provide some high-level instructions that I could use to create step-by-step instructions (once I get it working).

Is it roughly supposed to be:

  1. Fork the repo
  2. Clone the fork locally
  3. Create a branch for the update PR
  4. Run update.sh, for example to update Node 10.18.0 to 10.18.1 ./update.sh 10
  5. Commit the modified files to the branch and push to your fork
  6. Create a PR to be merged into master with the branch from your fork
@LaurentGoderre
Copy link
Contributor

@LaurentGoderre LaurentGoderre commented Jan 10, 2020

@clayzermk1 there was a bug that we fixed today about this.

@clayzermk1
Copy link
Contributor Author

@clayzermk1 clayzermk1 commented Jan 10, 2020

@LaurentGoderre excellent, thank you!

If there are no objections to my high level steps above, I'll give the script another go and add some instructions to the contributing doc.

@clayzermk1
Copy link
Contributor Author

@clayzermk1 clayzermk1 commented Jan 11, 2020

I'm going to close this issue out in favor of moving the discussion to the PR itself. Thanks!

@clayzermk1 clayzermk1 closed this Jan 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.