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

Preparing for Release v0.1.0 #18

Merged
merged 4 commits into from
Sep 19, 2023
Merged

Preparing for Release v0.1.0 #18

merged 4 commits into from
Sep 19, 2023

Conversation

abachma2
Copy link
Collaborator

This PR includes any final changes needed to create a release of v1.0.0. Right now, this is:

  • adding a BSD 3 License to the repo
  • updating the version number in the setup.py file

Is there anything else needed to create a release?

@abachma2 abachma2 self-assigned this Sep 15, 2023
@abachma2 abachma2 added Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:1-Critical This is the highest priority (i.e. it is blocking other work or facing a deadline). Status:5-In Review This issue has been handled, and the solution is being reviewed. (probably as a PR) labels Sep 15, 2023
Copy link
Member

@munkm munkm left a comment

Choose a reason for hiding this comment

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

I think you've covered the major points of the release. One thing you'll need to do is also tag the release (look up git tags in the git-scm documentation) at the commit that changes the version number. A tag is a special identifier that is useful for releases.

Do you plan to distribute the software (like on pypi ? )? That's another release step you may want to consider.

LICENSE Outdated
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2017, ERGS
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 the copyright line should be different here. The license should be attributed to ARFC or you. What is ERGS?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll look at the other licenses in the group repository, but I got this from the d3ploy repo. So we might want to revisit that one too.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll look at the other licenses in the group repository, but I got this from the d3ploy repo. So we might want to revisit that one too.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated the name, but we should also update the d3ploy license.

setup.py Outdated
@@ -2,7 +2,7 @@
from distutils.core import setup


VERSION = '0.0.1'
VERSION = '1.0.0'
Copy link
Member

Choose a reason for hiding this comment

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

How do you feel about doing a minor release instead of a major one (i.e. 0.1.0) -- that way you don't imply stability yet (usually the first major release means it is stable), but it is major enough for distribution.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That's probably a really good idea. I'll update the number.

@abachma2
Copy link
Collaborator Author

I don't plan on doing a pypi release or anything. Just have this housed here and create a zenodo object for it.

@abachma2 abachma2 requested a review from munkm September 15, 2023 18:25
@munkm munkm changed the title Preparing for Release v1.0.0 Preparing for Release v0.1.0 Sep 19, 2023
@munkm
Copy link
Member

munkm commented Sep 19, 2023

The changes in the code look good, but do you know why the tests are failing?

@abachma2
Copy link
Collaborator Author

The integration tests are failing because of a seg fault (Issue #12), but the unit tests all pass locally. The CI tests need to bu updated to show the unit tests working, likely having separate jobs to run the integration and unit tests.

@munkm
Copy link
Member

munkm commented Sep 19, 2023

Ok that sounds good. In a separate conversation Amanda and I discussed fixing this for a future release, but this isn't blocking for this PR.

@munkm munkm merged commit df40e52 into arfc:main Sep 19, 2023
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Comp:Core This issue has to do with the main bulk of the code or document. (methods, main content) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:1-Critical This is the highest priority (i.e. it is blocking other work or facing a deadline). Status:5-In Review This issue has been handled, and the solution is being reviewed. (probably as a PR)
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants