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

Document and automate new release process #299

Merged
merged 2 commits into from
May 24, 2021

Conversation

alamb
Copy link
Contributor

@alamb alamb commented May 16, 2021

Re #292

This PR contains documentation and scripts for the arrow-rs release process. It will probably evolve as we do this a few more times.

Rationale for this change

Make release process simple and repeatable

What changes are included in this PR?

  1. Comprehensive documentation
  2. Scripts to automate the various steps

Are there any user-facing changes?

Not directly

@codecov-commenter
Copy link

codecov-commenter commented May 16, 2021

Codecov Report

Merging #299 (a59cd52) into master (c863a2c) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #299      +/-   ##
==========================================
- Coverage   82.52%   82.52%   -0.01%     
==========================================
  Files         162      162              
  Lines       44007    44007              
==========================================
- Hits        36316    36315       -1     
- Misses       7691     7692       +1     
Impacted Files Coverage Δ
parquet/src/encodings/encoding.rs 94.85% <0.00%> (-0.20%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c863a2c...a59cd52. Read the comment docs.

Copy link
Member

@jorgecarleitao jorgecarleitao left a comment

Choose a reason for hiding this comment

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

LG so far. Thanks a lot, @alamb !

dev/release/README.md Outdated Show resolved Hide resolved
dev/release/README.md Outdated Show resolved Hide resolved
@jorgecarleitao
Copy link
Member

cc @kszucs

@alamb alamb added the development-process Related to development process of arrow-rs label May 18, 2021
@alamb alamb marked this pull request as ready for review May 22, 2021 10:57
@alamb
Copy link
Contributor Author

alamb commented May 22, 2021

This is ready for review at your convenience @jorgecarleitao / @andygrove

@alamb alamb changed the title Document and automate new release process (WIP) Document and automate new release process May 22, 2021
should) then the crate can be published with the following command:

```shell
cargo publish
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't work unfortunately. We have to manually go to each crate directory and run cargo publish for each one, in order.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks -- I added the following (and I will test / update the docs again after I try with the next arrow release)

(cd arrow && cargo publish)
(cd arrow_flight && cargo publish)
(cd parquet && cargo publish)
(cd parquet_derive && cargo publish)

Comment on lines 234 to 236
If the Cargo.toml does not have the correct version then it will be necessary
to modify it manually. Since there is now a modified file locally that is not
committed to GitHub it will be necessary to use the following command.

```shell
cargo publish --allow-dirty
```
Copy link
Member

Choose a reason for hiding this comment

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

I think we can remove this section now. This was here because we had issues with the scripts updating the version numbers early on. We should check that the version numbers are correct when voting on a release candidate.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will remove

@alamb
Copy link
Contributor Author

alamb commented May 24, 2021

I plan to merge this PR in and then iterate on the docs and scripts as we do some more releases. I am happy to make any other changes as part of a subsequent PR

@alamb alamb merged commit 5295e25 into apache:master May 24, 2021
@alamb alamb deleted the alamb/new-release branch June 15, 2021 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development-process Related to development process of arrow-rs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants