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

Mismatch in documentation and in release notes #1467

Closed
meaz opened this issue Apr 14, 2024 · 3 comments
Closed

Mismatch in documentation and in release notes #1467

meaz opened this issue Apr 14, 2024 · 3 comments
Labels
Configuration Something wrong with the setup Dependencies Any software dependancies problems

Comments

@meaz
Copy link

meaz commented Apr 14, 2024

Description

In https://github.com/cryptpad/cryptpad/releases/tag/2024.3.0, it is written that upgrading is done by:

npm ci
npm run install:components

And in https://docs.cryptpad.org/en/admin_guide/maintenance.html#upgrading-cryptpad, it is written that upgrading is done by:

npm update
npm run install:components

Which one is right?

When I try with npm ci I get npm ci can only install packages when your package.json and package-lock.json or npm-shrinkwrap.json are in sync. Please update your lock file with npm install before continuing. I don't have that error when using npm update

Steps to reproduce

Run npm update

Relevant logs

`npm ci can only install packages when your package.json and package-lock.json or npm-shrinkwrap.json are in sync. Please update your lock file with npm install before continuing.`

Expected behavior

npm ci should just work or the documentation should be updated.

Which operating system are you using?

Linux/BSD/UNIX

What browsers are you seeing the problem on?

Mozilla Firefox

Extensions

None

Version

2024.3.0

@mathilde-cryptpad
Copy link
Contributor

Hello,

Due to an error merging a branch with a dependencies fix just before the release, we messed up our package-lock.json. It was released not in sync with package.json anymore.

To fix this we have updated the upgrade notes in the release changelog. Simply running npm install, instead of npm ci, will fix the issue. Of course, the root cause of the problem will be fixed in a coming release.

@mathilde-cryptpad mathilde-cryptpad added Configuration Something wrong with the setup Dependencies Any software dependancies problems labels Apr 15, 2024
@meaz
Copy link
Author

meaz commented Apr 15, 2024

Thanks @mathilde-cryptpad though I still have that answer if the "normal" way to update is npm ci or npm update.

@mathilde-cryptpad
Copy link
Contributor

@meaz there is no "normal" way, it depends on each release. Our next release of the documentation will explicitly refer to the GitHub release upgrade instructions: cryptpad/documentation@699715a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Configuration Something wrong with the setup Dependencies Any software dependancies problems
Projects
None yet
Development

No branches or pull requests

2 participants