Skip to content

AVRO-3868: [Rust][CI] Check consistency between the doc comment in lib.rs and README.md#2510

Merged
martin-g merged 3 commits intoapache:masterfrom
sarutak:consistent-readme
Sep 22, 2023
Merged

AVRO-3868: [Rust][CI] Check consistency between the doc comment in lib.rs and README.md#2510
martin-g merged 3 commits intoapache:masterfrom
sarutak:consistent-readme

Conversation

@sarutak
Copy link
Member

@sarutak sarutak commented Sep 20, 2023

AVRO-3868

What is the purpose of the change

This PR proposes to add a consistency check between the doc comment in avro/src/lib.rs and avro/README.md.
AVRO-3849 added cargo-rdme so it's nice if we can check the consistency between them.

Verifying this change

Done by GitHub Actions.

Documentation

  • Does this pull request introduce a new feature? (no)

@github-actions github-actions bot added the build label Sep 20, 2023
@martin-g
Copy link
Member

The change looks good but installing cargo-rdme takes 5 mins ... This makes the CI 5 mins slower ...
I wonder how useful this is. Most of the users use docs.rs. An out-of-date README.md is not a big deal.

@sarutak
Copy link
Member Author

sarutak commented Sep 21, 2023

I wonder how useful this is. Most of the users use docs.rs. An out-of-date README.md is not a big deal.

I think an out-of-date README.md is not a big deal too but an out-of-date doc.rs is an issue.
It really happened before 7ff2d7a.

Making CI slower is indeed not good so how about caching cargo-rdme?

@martin-g
Copy link
Member

Making CI slower is indeed not good so how about caching cargo-rdme?

That would be OK!

@sarutak
Copy link
Member Author

sarutak commented Sep 21, 2023

cargo-rdme seems to be cached as expected.
https://github.com/apache/avro/actions/runs/6266491283/job/17017596658?pr=2510#step:6:16

@martin-g martin-g merged commit 76c2ca6 into apache:master Sep 22, 2023
martin-g pushed a commit that referenced this pull request Sep 22, 2023
…b.rs and README.md (#2510)

* Cache cargo-rdme

* Unuse cargo-install

* Trigger GA to check effect of cache

(cherry picked from commit 76c2ca6)
@martin-g
Copy link
Member

Thank you, @sarutak !

RanbirK pushed a commit to RanbirK/avro that referenced this pull request May 13, 2024
…b.rs and README.md (apache#2510)

* Cache cargo-rdme

* Unuse cargo-install

* Trigger GA to check effect of cache
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants