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.

Sign up for GitHub

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

Jump to bottom

chore: add Readme.md links in each Cargo.toml #4030

Merged
merged 2 commits into from
Jan 12, 2024
Merged

chore: add Readme.md links in each Cargo.toml #4030

merged 2 commits into from
Jan 12, 2024

Conversation

15IITian
Copy link
Contributor

Added Readme.md links in those Crate.toml where there exists a README.md file in that individual crate
#3924

@15IITian
chore: add Readme.md links in each Cargo.toml
6de2f54 
Added Readme.md links in those Crate.toml where there exists a README.md file in that individual
crate
@15IITian 15IITian requested review from a team as code owners January 11, 2024 16:42
@codecov Codecov
Copy link

codecov bot commented Jan 11, 2024 •
edited

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d606aaf) 57.73% compared to head (77de470) 57.73%.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #4030   +/-   ##
=======================================
  Coverage   57.73%   57.73%           
=======================================
  Files         193      193           
  Lines       42948    42948           
=======================================
+ Hits        24794    24798    +4     
+ Misses      18154    18150    -4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dpc
dpc reviewed Jan 11, 2024
View reviewed changes
Cargo.toml Outdated
@@ -61,6 +61,7 @@ keywords = ["bitcoin", "lightning", "chaumian", "e-cash", "federated"]
threshold_crypto = { version = "0.1", package = "fedimint-threshold-crypto" }
tonic_lnd = { version = "0.1.3", package="fedimint-tonic-lnd", features = ["lightningrpc", "routerrpc"] }
cln-rpc = { package = "fedimint-cln-rpc", version = "0.4.0" }
fedimint-aead = { version = "0.0.1" }
Copy link
Contributor

Choose a reason for hiding this comment

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

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

By Mistake, I thought that I have to include this line in root Cargo.toml file as per the screenshot :)

@15IITian 15IITian marked this pull request as draft January 12, 2024 08:17
@15IITian 15IITian marked this pull request as ready for review January 12, 2024 09:55
@15IITian
Copy link
Contributor Author

image

Not getting why these links are dead as I have not made any changes in it & they are working fine in the Readme.md file .

elsirion
elsirion approved these changes Jan 12, 2024
View reviewed changes
Copy link
Contributor

@elsirion elsirion left a comment

Choose a reason for hiding this comment

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

Doesn't fully solve #3924 since crates without README still don't have any linked, but it's an improvement.

@15IITian
Copy link
Contributor Author

Doesn't fully solve #3924 since crates without README still don't have any linked, but it's an improvement.

For the crates not having their own README -> I have to give link of the root Readme file?

@elsirion
Copy link
Contributor

For the crates not having their own README -> I have to give link of the root Readme file?

I think that's a complicated problem since the root README isn't included when publishing sub-crates by default (see my comment in the issue). So this requires some Cargo wizardry, which is probably not worth it rn.

@15IITian
Copy link
Contributor Author

15IITian commented Jan 12, 2024 •
edited

For the crates not having their own README -> I have to give link of the root Readme file?

I think that's a complicated problem since the root README isn't included when publishing sub-crates by default (see my comment in the issue). So this requires some Cargo wizardry, which is probably not worth it rn.

Okk,
I think that's the same problem in the License field case in each Cargo.toml?
If yes , then what else I have to do as for now??

@15IITian
Copy link
Contributor Author

@elsirion
For testing, I have published one sub_crate named another_trial from a workspace , which do not has its own README file -> thus has relative path of the root README file-> and that's working fine as required ->

image

image

@dpc dpc added this pull request to the merge queue Jan 12, 2024
Merged via the queue into fedimint:master with commit 5edd8b4 Jan 12, 2024
19 of 20 checks passed
@elsirion
Copy link
Contributor

Interesting, then let's try this in another PR!

15IITian added a commit to 15IITian/fedimint that referenced this pull request Jan 15, 2024
@15IITian
chore: remove paths for unpublished crates
2f756d3 
Removed the relative paths of root README.md file from the  unpublished crates.(from
fedimint-load-test-tool crate also -> It is unpublished crate but was merged fedimint#4030)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dpc dpc dpc approved these changes

@elsirion elsirion elsirion approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@15IITian @elsirion @dpc