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

AVRO-3205 Rust: Update Cargo.toml [package] information #1344

Merged
merged 5 commits into from
Jan 5, 2022
Merged

AVRO-3205 Rust: Update Cargo.toml [package] information #1344

merged 5 commits into from
Jan 5, 2022

Conversation

martin-g
Copy link
Member

@martin-g martin-g commented Sep 22, 2021 •
edited
Loading

Jira

  • My PR addresses the following AVRO-3205 issue.

Tests

  • My PR does not need testing for this extremely good reason: Only [package] in Cargo.toml is being changed

Commits

  • My commits all reference Jira issues in their subject lines.

Documentation

  • No need of documentation

@github-actions github-actions bot added the Rust label Sep 22, 2021
@martin-g martin-g changed the title AVRO-3205 Update Cargo.toml [package] information AVRO-3205 Rust: Update Cargo.toml [package] information Sep 22, 2021
@martin-g
AVRO-3205 Fix 'cargo doc` warning
d943229 
Documenting avro-rs v0.14.0 (/home/martin/git/apache/avro/lang/rust)
warning: this URL is not a hyperlink
   --> src/lib.rs:696:5
    |
696 | //! flavray/avro-rs#76).
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://github.com/flavray/avro-rs/pull/76>`
    |
    = note: `#[warn(rustdoc::bare_urls)]` on by default
    = note: bare URLs are not automatically turned into clickable links
@martin-g
AVRO-3205 Add keywords and documentation to [package]
fc0fd8e
@martin-g
Copy link
Member Author

@iemejia Could you please review this PR ? Thank you!

@ultrabug
Copy link
Contributor

@martin-g thanks for this, this is indeed very needed because this causes some confusion around this crate's development up to the rust doc itself..

You might want to update:

README.md:23:[![Continuous Integration](https://github.com/flavray/avro-rs/workflows/Continuous%20Integration/badge.svg)](https://github.com/flavray/avro-rs/actions)
README.md:25:[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/flavray/avro-rs/blob/main/LICENSE)
README.md:586:https://github.com/flavray/avro-rs/pull/76).
README.md:617:This project is licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE).
README.md:622:All contributions will be licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE).
README.md:624:Please consider adding documentation, tests and a line for your change under the Unreleased section in the [CHANGELOG](https://github.com/flavray/avro-rs/blob/main/CHANGELOG.md).


README.tpl:4:[![Continuous Integration](https://github.com/flavray/avro-rs/workflows/Continuous%20Integration/badge.svg)](https://github.com/flavray/avro-rs/actions)
README.tpl:6:[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/flavray/avro-rs/blob/main/LICENSE)
README.tpl:11:This project is licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE).
README.tpl:16:All contributions will be licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE).
README.tpl:18:Please consider adding documentation, tests and a line for your change under the Unreleased section in the [CHANGELOG](https://github.com/flavray/avro-rs/blob/main/CHANGELOG.md).


src/schema_compatibility.rs:845:    // https://github.com/flavray/avro-rs/pull/76

@martin-g
AVRO-3205 Update markdown files
e112167 
Replace flavray/avro-rs with apache/avro.
Replace MIT license with Apache License 2
@martin-g
Copy link
Member Author

src/schema_compatibility.rs:845: // flavray/avro-rs#76

This is still useful! The comment could be removed once the issue/limitation is solved!

@ultrabug
Copy link
Contributor

This is still useful! The comment could be removed once the issue/limitation is solved!

I was referring to the fact that you might have wanted to add <> around it since you did it on another comment in another file

@martin-g
Copy link
Member Author

Ah! I didn't understand you!
I've made the change in the other file because it was part of a documentation and cargo doc was complaining.
This line here is a plain comment and not parsed by cargo doc so it could be anything.

@martin-g
Copy link
Member Author

I use the following Fish shell function to validate Avro Rust code before Git push:

function avro_full_check
  command cargo test -- --test-threads (nproc) --format terse && cargo fmt --all -- --check && cargo clippy  --all-features --all-targets -- -Dclippy::all -Dunused_imports && cargo doc
end

It does the same as what we have in the GitHub Actions workflows.

@ultrabug
Copy link
Contributor

@martin-g how's the merge/release process working for this crate now that it's under the Apache umbrella? I must admit that seeing such a PR opened for almost a month scares me a bit :/ so I don't even dare think of my own PR...

@martin-g
Copy link
Member Author

The problem is that the original developers of Avro-rs are not yet Apache Avro committers. I hope this will be solved very soon!

@ultrabug
Copy link
Contributor

I hope this will be solved very soon!

Any idea / tracking about this timing? no actual members of the project can manage this while it's done?

@ultrabug
Copy link
Contributor

Any idea / tracking about this timing? no actual members of the project can manage this while it's done?

friendly bump @martin-g

@martin-g
Copy link
Member Author

@ultrabug I also have several PRs waiting for approval and merge ...

@RyanSkraba @iemejia Please vote me as a committer ! :-)

@ultrabug
Copy link
Contributor

(yep I saw that Martin)

@RyanSkraba @iemejia please 👍

@ultrabug
Copy link
Contributor

ultrabug commented Jan 3, 2022

Hello, and happy (and healthy) new year to everyone!

I'd like to friendly bump this PR to get an update on the Rust maintenance for Apache Avro? We've been stuck (and patient) for a very long time now...

@martin-g martin-g merged commit ea07ac0 into apache:master Jan 5, 2022
@martin-g martin-g deleted the avro-3205-update-package-info branch January 5, 2022 05:48
@martin-g
Copy link
Member Author

martin-g commented Jan 5, 2022

Happy New Year, @ultrabug !
https://lists.apache.org/thread/67jcrd0bq8knxmv6loqchmt5g4q7ry27

@ultrabug
Copy link
Contributor

ultrabug commented Jan 5, 2022

OMG congratulations @martin-g 🤗

martin-g added a commit that referenced this pull request Feb 1, 2022
@martin-g
AVRO-3205 Rust: Update Cargo.toml [package] information (#1344)
81812a0 
* AVRO-3205 Update Cargo.toml [package] information

* AVRO-3205 Fix 'cargo doc` warning

Documenting avro-rs v0.14.0 (/home/martin/git/apache/avro/lang/rust)
warning: this URL is not a hyperlink
   --> src/lib.rs:696:5
    |
696 | //! flavray/avro-rs#76).
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://github.com/flavray/avro-rs/pull/76>`
    |
    = note: `#[warn(rustdoc::bare_urls)]` on by default
    = note: bare URLs are not automatically turned into clickable links

* AVRO-3205 Add keywords and documentation to [package]

* AVRO-3205 Add categories = ["encoding"]

* AVRO-3205 Update markdown files

Replace flavray/avro-rs with apache/avro.
Replace MIT license with Apache License 2

(cherry picked from commit ea07ac0)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Rust
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@martin-g @ultrabug