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

docs(README): wrong crate name in cargo install instructions #964

Merged

Conversation

adamperkowski
Copy link
Collaborator

Resolves #963

@adamperkowski adamperkowski added bug Something isn't working documentation Improvements or additions to documentation labels Nov 22, 2024
@@ -95,7 +95,7 @@ sudo zypper install linutil
Linutil can be installed via [Cargo](https://doc.rust-lang.org/cargo) with:

```bash
cargo install linutil
cargo install linutil_tui

Choose a reason for hiding this comment

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

Should probably add --locked to it as well since the version currently on crates cannot compile because one of the dependencies broke semver. Using --locked will have the install only use the dependent versions that are in the Cargo.lock file rather than the latest semver matching ones.

(The broken dependency really needs to fix that, cargo-semver-checks exists for a reason after all, lol)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks for pointing that out. I really have no idea what's going on with versioning here. I'll try to fix all this today but @ChrisTitusTech IMO you really should check if crates 100% work before releasing.

I'm not sure if this will work though, as Cargo.lock is not included in the packages.

include = ["src/*.rs", "Cargo.toml", "cool_tips.txt", "../man/linutil.1"]

include = ["src/*.rs", "Cargo.toml", "tabs/**"]

@adamperkowski
Copy link
Collaborator Author

adamperkowski commented Nov 22, 2024

@ChrisTitusTech Why is the version in Cargo.toml == 24.9.28 on the 24.10.31 tag?

version = "24.9.28"

@lj3954
Copy link
Contributor

lj3954 commented Nov 22, 2024

Release workflow should be modified to update versions in Cargo.toml

@lj3954
Copy link
Contributor

lj3954 commented Nov 22, 2024

@ChrisTitusTech Why is the version in Cargo.toml == 24.9.28 on the 24.10.31 tag?

version = "24.9.28"

#965 will resolve this issue.

@ChrisTitusTech ChrisTitusTech merged commit c86f014 into ChrisTitusTech:main Nov 25, 2024
1 check passed
@adamperkowski adamperkowski deleted the docs/cratesinstall branch November 25, 2024 00:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cargo installation instructions incorrect
5 participants