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

Pypi release #498

Merged
merged 4 commits into from
Jan 30, 2023
Merged

Pypi release #498

merged 4 commits into from
Jan 30, 2023

Conversation

kissgyorgy
Copy link
Contributor

@kissgyorgy kissgyorgy commented Jan 25, 2023

I made the GitHub Action to release the Python package to PyPI, the same as we did for
https://github.com/onekey-sec/python-client.
WIP, because you need to come up with a versioning scheme before this can be used.
I think the POETRY_PYPI_TOKEN_PYPI secret is org level, but I don't remember, need to be checked.

Fixes #493

@kissgyorgy kissgyorgy marked this pull request as draft January 25, 2023 09:56
@kissgyorgy kissgyorgy changed the title [WIP] Pypi release Pypi release Jan 25, 2023
@qkaiser
Copy link
Contributor

qkaiser commented Jan 25, 2023

Very cool !

@qkaiser
Copy link
Contributor

qkaiser commented Jan 26, 2023

On versioning scheme, I think we should use the same scheme than the one we used with python-client (major.minor.patch). I'd start with 0.1.1 since we're currently on 0.1.0 (and always were before).

@kissgyorgy
Copy link
Contributor Author

kissgyorgy commented Jan 26, 2023

I asked about the versioning scheme, because it is a somewhat complex question.
Here are a couple of questions:

  • Do we consider unblob stable at this point? from what point? As a library or a CLI?
  • What does the version mean? API stability? Command line interface stability? Extract folder structure? JSON metadata output?
  • How often will you break the contract?
  • Different version schemes communicate different things to users. How do you want to communicate the changes or the overall state of the project? https://calver.org/ and https://semver.org/ are very different
  • When do you want to bump version numbers? Every release? Only when API changes? Only when CLI interface changes?

I think it makes sense to consider CalVer, which would essentially mean "this project is constantly improved, the release version means nothing and we don't guarantee any kind of stability between versions". Maye this would manage user expectations better?

@martonilles
Copy link
Contributor

Agree, I would use preferably calver, like this: YYYY.MM.DD or YYYY.MM.MICRO otherwise in semver, I would go for a 1.1.0 release now as I think we are stable for a while.

@kissgyorgy
Copy link
Contributor Author

kissgyorgy commented Jan 26, 2023

I added documentation in the install section on how to install from PyPI.

@qkaiser qkaiser self-requested a review January 26, 2023 13:38
docs/installation.md Show resolved Hide resolved
@kissgyorgy
Copy link
Contributor Author

I would go for a 1.1.0 release now as I think we are stable for a while.

There are 3 milestones, none of them are closed: https://github.com/onekey-sec/unblob/milestones
At least we should solve #353 and #243 before we should call it 1.0, so people can rely on the behavior of the CLI and the stability of the API (as a library).

Or we could use calver immediately with no guarantees and delete the milestones 😄

@qkaiser qkaiser marked this pull request as ready for review January 26, 2023 13:39
@qkaiser
Copy link
Contributor

qkaiser commented Jan 26, 2023

Marked as ready. Let's use calendar versioning (my preference goes to YYYY.MM.DD). I leave the merge, version bump, and first release to our overlord @martonilles 🙇

This specific YAML fields need a string, not a float.
Removed global install recommendation, as it can potentially
break the system.
@martonilles martonilles merged commit 440f50d into onekey-sec:main Jan 30, 2023
@kissgyorgy kissgyorgy deleted the pypi-release branch January 30, 2023 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Binary Installation
3 participants