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

Improve release docs #101

Merged
merged 5 commits into from
May 11, 2020
Merged

Improve release docs #101

merged 5 commits into from
May 11, 2020

Conversation

znicholls
Copy link
Collaborator

@znicholls znicholls commented May 5, 2020

Pull request

Please confirm that this pull request has done the following:

  • Hotfix pip install test #93
  • Tests added (N/A)
  • Documentation added (where applicable)
  • Example added (either to an existing notebook or as a new notebook, where applicable)
  • Description in CHANGELOG.rst added

Adding to CHANGELOG.rst

Please add a single line in the changelog notes similar to one of the following:

- (`#XX <https://github.com/znicholls/silicone/pull/XX>`_) Added feature which does something
- (`#XX <https://github.com/znicholls/silicone/pull/XX>`_) Fixed bug identified in (`#YY <https://github.com/znicholls/silicone/issues/YY>`_)

@znicholls
Copy link
Collaborator Author

znicholls commented May 5, 2020

Questions for @Rlamboll and @jkikstra on top of general review:

  • would a link to an explanation of how semantic versioning works be useful?
  • would a link to an explanation of how versioneer works be useful (e.g. 0.2.0 isn't a valid tag I don't think @Rlamboll)?
  • do you want a stronger protocol for deciding when we make new versions (my opinion has always been that releases are basically free so it's not worth stressing about but others are much stricter e.g. pyam)?

You can see the CI-CD pipeline doing it's thing in the pipelines for the v0.1.0rc tag and the 0.2.0 tag.

Copy link
Collaborator

@Rlamboll Rlamboll left a comment

Choose a reason for hiding this comment

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

That is a lot simpler than before!

@Rlamboll
Copy link
Collaborator

Rlamboll commented May 5, 2020

Questions for @Rlamboll and @jkikstra on top of general review:

  • would a link to an explanation of how semantic versioning works be useful?
    Not really, we can google it
  • would a link to an explanation of how versioneer works be useful (e.g. 0.2.0 isn't a valid tag I don't think @Rlamboll)?
    Yes, I'm surprised that finding the documentation for how to use it (rather than what the codebase is) is so difficult.
  • do you want a stronger protocol for deciding when we make new versions (my opinion has always been that releases are basically free so it's not worth stressing about but others are much stricter e.g. pyam)?
    No, large version numbers are fine

You can see the CI-CD pipeline doing it's thing in the pipelines for the v0.1.0rc tag and the 0.2.0 tag.
Indeed, I apparently pip-installed it correctly (it ignores the 0.2.0 version).

@Rlamboll
Copy link
Collaborator

Rlamboll commented May 6, 2020

It doesn't actually pass the tests however, I get
from openscm_units.unit_registry import ScmUnitRegistry
E ModuleNotFoundError: No module named 'openscm_units'

(I have openscm-units installed in this env and this persists even if I revert to openscm-units 0.1.1, which is what I was previously using.) Will have another look in the morning.

@znicholls
Copy link
Collaborator Author

It doesn't actually pass the tests

As in make test-pypi-install doesn't work? Everything works on the CI servers from what I can tell.

@Rlamboll
Copy link
Collaborator

Rlamboll commented May 6, 2020

I wasn't running make because windows. I've tried it again and it works now, so I'm not sure what the problem was (I cleared the cache). Anyway, it seems to work for Joeri when installed everything from scratch, so presumably a problem connected to conda recovering old versions of files somehow?

@znicholls
Copy link
Collaborator Author

Ye weird, sometimes things don’t reinstall properly unless you start fresh..

@znicholls
Copy link
Collaborator Author

After #93 I think this is good to go too @Rlamboll

@znicholls znicholls marked this pull request as ready for review May 10, 2020 23:29
@Rlamboll
Copy link
Collaborator

OK @znicholls, I don't think Jarmo is going to review this so merge them at will

@znicholls znicholls merged commit 2e64d8a into master May 11, 2020
@znicholls znicholls deleted the improve-release-docs branch May 11, 2020 00:30
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.

2 participants