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(python, rust): Add release flow info to contributing guide #6480

Merged
merged 3 commits into from
Jan 31, 2023

Conversation

stinodego
Copy link
Member

@stinodego stinodego commented Jan 26, 2023

Relates to #6319

Changes:

  • Add licensing information to table of contents and move it to bottom of the file
  • Update Python linting information
  • Add release flow for Rust and Python.

Note that I added some 'wishful thinking' when it comes to describing the Rust release process - I believe we should formalize this in a GitHub action.

@ritchie46 Could you let me know what local commands you run to release a new Rust crate? And do you agree it would be nice to have this trigger on a new GitHub Rust release? Then I'll create a workflow for it. (you will probably have to set some secret in GitHub for this, just like PYPI_PASS utilized by the Python release workflow)

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars labels Jan 26, 2023
@stinodego stinodego marked this pull request as ready for review January 27, 2023 09:37
@ritchie46
Copy link
Member

I have to check if cargo publish is fault tolerant currently with multiple crates. It has a new feature, so it might be.

Currently we simply sleep in between publishes and hope it's long enough. Sometimes I republish.

Do we want to go for the release publish flow in the future?

@stinodego
Copy link
Member Author

Do we want to go for the release publish flow in the future?

If possible, I think it makes sense to have the same release flow for both Rust and Python. But for now let's focus on getting the Python flow in order.

Turns out that for Python, to achieve the release flow I described in the office the other day (and which is described in this PR) is possible without any changes to the GitHub workflow.

Do you want to give this a shot next release, tell me if it works well?

@ritchie46
Copy link
Member

Do you want to give this a shot next release, tell me if it works well?

Ah, makes sense as the release also creates a tag. Yes. I will do that next time.

@ritchie46
Copy link
Member

Feel free to merge when ready.

@stinodego
Copy link
Member Author

All right - I'll just merge it, and we can update as we go along if you decide the release process should be adjusted.

@stinodego stinodego merged commit 954ec11 into pola-rs:master Jan 31, 2023
Vincenthays pushed a commit to Vincenthays/polars that referenced this pull request Feb 9, 2023
@stinodego stinodego deleted the release-strategy branch February 22, 2023 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants