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

help wanted! #104

Open
rabernat opened this issue Jun 14, 2018 · 20 comments
Open

help wanted! #104

rabernat opened this issue Jun 14, 2018 · 20 comments
Labels

Comments

@rabernat
Copy link
Contributor

This issue is just to make it clear that I am explicitly looking for volunteers to take on responsibility for versioning (#101), packaging (#100), documentation, and overall administration of xgcm. I just don't have time to tackle these things any time soon, but they are important for the long-term sustainability of this project.

For example, @jbusecke, @raphaeldussin, @willirath, @maikejulie, @jetesdal or anyone else who wants to learn more about how that stuff works, this is an opportunity to do so...

@raphaeldussin
Copy link
Contributor

count me in!

@jbusecke
Copy link
Contributor

jbusecke commented Jun 14, 2018 via email

@rabernat
Copy link
Contributor Author

Great, thanks! I have given you both write access, so you can commit / merge PRs. (I would strongly prefer that all changes continue to come through PRs.) I probably also have to give you permissions on pypi--I'll try to sort that out asap.

So basically just start doing it. I recommend starting by copying xarray's "how to release" instructions / adapting them for xgcm:
https://github.com/pydata/xarray/blob/master/HOW_TO_RELEASE

@rabernat
Copy link
Contributor Author

In order to get permissions to publish on pypi, you need to make accounts there and then tell me your usernames. I will add you to the xgcm project: https://pypi.org/project/xgcm/

@willirath
Copy link
Contributor

willirath commented Jun 14, 2018 via email

@rabernat
Copy link
Contributor Author

Just to be clear, the near-term goal is to release xgcm v 0.2.0 via pip and conda-forge.

@jbusecke
Copy link
Contributor

Do we have concrete milestones for 0.2.0 (e.g. working metrics module and perhaps vector calculus?)

@jbusecke
Copy link
Contributor

Joined PyPI (username: jbusecke)

@raphaeldussin
Copy link
Contributor

same (username: raphaeldussin)

@rabernat
Copy link
Contributor Author

Ok you are both added as maintainers.

Let's make 0.2.0 just the current state of the project. No need to wait for those hard things to get done. We have not had a release in a long time, and there are already many improvements that we need to get out there.

We can discuss milestones for 0.3.0 in a separate issue.

@raphaeldussin
Copy link
Contributor

from the pypi and conda docs, it seems that the way to go is to start with creating the pypi package
then the conda recipe. I can start testing it next week if that's ok with everybody.

@maikejulie
Copy link

Happy to be involved, but a bit busy out June sorry!

@jbusecke
Copy link
Contributor

Sounds great. I have started a todo list (#105), where we can discuss what is still missing for a clean release of v0.2.0. Perhaps its only the things that I have to do...then this might have been a bit overkill.

Either way let me know if there are things (particularly in the documentation) that are still needed.

@rabernat
Copy link
Contributor Author

from the pypi and conda docs, it seems that the way to go is to start with creating the pypi package
then the conda recipe. I can start testing it next week if that's ok with everybody.

Note that @ocefpaf has already created a conda-forge package for us (https://github.com/conda-forge/xgcm-feedstock), but it needs some attention (see discussion here: conda-forge/staged-recipes#6056 (comment)). He would be a great person to ask if you have questions about releasing.

As for the overall release procedure, I highly recommend you follow the procedure described in the xarray HOW_TO_RELEASE document:
https://github.com/pydata/xarray/blob/master/HOW_TO_RELEASE

@jbusecke
Copy link
Contributor

Now that we have a more active development team should we close this? If we still want to highlight this issue, can we pin it somehow to the top? Otherwise it will not be seen I am afraid.

@jbusecke jbusecke pinned this issue Sep 11, 2020
@jbusecke
Copy link
Contributor

Ah there it is. I pinned this to the top.

@ocefpaf
Copy link
Contributor

ocefpaf commented Sep 16, 2020

He would be a great person to ask if you have questions about releasing.

I usually recommend people to take a look at https://github.com/ioos/ioos-python-package-skeleton

As for the overall release procedure, I highly recommend you follow the procedure described in the xarray HOW_TO_RELEASE document:
pydata/xarray@master/HOW_TO_RELEASE

Got a broken link in that but xarray is a bigger project and needs more human intervention for a release. This project is in good shape and I would recommend something simpler and automated:

  • dropping versioneer, which is deprecated, and adopting setuptools_scm;
  • adding some sdist tarball/wheels tests (see link above);
  • use a GH action to release every new tag.

I can send PRs to implent those if you want to adopt that wokflow.

@github-actions
Copy link

This issue has been marked 'stale' due to lack of recent activity. If there is no further activity, the issue will be closed in another 30 days. Thank you for your contribution!

@github-actions github-actions bot added the Stale label Jun 11, 2021
@github-actions
Copy link

This issue has been closed due to inactivity. If you feel this is in error, please reopen the issue or file a new issue with the relevant details.

@jbusecke jbusecke added keepOpen and removed Stale labels Jun 22, 2021
@jbusecke
Copy link
Contributor

I would like to keep this open, since it is a general announcement?

@jbusecke jbusecke reopened this Jun 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

6 participants