Skip to content
This repository has been archived by the owner on Sep 2, 2024. It is now read-only.

819 add dodal and nexgen versions to release notes #1305

Merged
merged 6 commits into from
May 17, 2024

Conversation

rtuck99
Copy link
Contributor

@rtuck99 rtuck99 commented Apr 10, 2024

Fixes #819

Link to dodal PR (if required): #N/A
(remember to update setup.cfg with the dodal commit tag if you need it for tests to pass!)

To test:

  1. Perform a release as per the instructions on the wiki https://github.com/DiamondLightSource/hyperion/wiki/Creating-a-release-and-deploying-it
  2. Confirm nexgen and dodal versions appear in release notes along with normal generated release notes
  3. Confirm released version setup.cfg has dependencies correctly pinned.

Copy link
Collaborator

@DominicOram DominicOram left a comment

Choose a reason for hiding this comment

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

I created the release at https://github.com/DiamondLightSource/hyperion/releases/tag/untagged-0eb09fe04a1a13594f36 but it had some issues:

@rtuck99
Copy link
Contributor Author

rtuck99 commented Apr 30, 2024

I created the release at https://github.com/DiamondLightSource/hyperion/releases/tag/untagged-0eb09fe04a1a13594f36 but it had some issues:

* Must: The code was pinned to `dodal == 1.13.1` but the latest is https://github.com/DiamondLightSource/dodal/releases/tag/1.22.0 (https://pypi.org/project/dls-dodal/)

* Could: It would be better if rather than just saying "these were the versions" links were provided to the release notes

* Nit: I think the version numbers are less interesting than what's changed so can we put them at the bottom of the release notes?

Hmm, looking at the logs, it installs the right version of dodal.... then it installs the wrong version on top. Not sure if it's related to the bluesky api conflict but will investigate

@DominicOram
Copy link
Collaborator

Could be, looks like the blueapi pin was wrong, we wanted the pre-release of https://github.com/DiamondLightSource/blueapi/releases/tag/0.4.2-a1.

@DominicOram
Copy link
Collaborator

As discussed, I think the correct answer is that we should have been pinning our blue-api version before the release.

@rtuck99
Copy link
Contributor Author

rtuck99 commented May 14, 2024

Ok, I think the blue-api versioning issue is another thing to the dodal versioning issue - I think these are the alternative ways of pinning.

  • We pip install with --pre and explicitly pin all our "stable" dependencies to release versions, don't pin things like dodal, bluesky etc.
  • We never install with --pre and we only explicitly pin those dependencies where we want to be on the bleeding edge pre-release versions
  • We explicitly pin everything

I think it's a toss up between 1 and 2 - 1 has more things pinned but we might update less frequently

@DominicOram
Copy link
Collaborator

Agreed that will go for option 2 and pin bluesky, blueapi and ophyd-async

@rtuck99 rtuck99 requested a review from DominicOram May 14, 2024 15:19
Copy link
Contributor

@d-perl d-perl left a comment

Choose a reason for hiding this comment

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

Great, thanks!

@d-perl d-perl dismissed DominicOram’s stale review May 17, 2024 09:13

this is an improvement, we can always iterate

@d-perl d-perl merged commit d140662 into main May 17, 2024
6 checks passed
@d-perl d-perl deleted the 819_add_dodal_nexgen_version_to_release_notes_part_2 branch May 17, 2024 09:13
olliesilvester pushed a commit to olliesilvester/mx-bluesky that referenced this pull request Aug 23, 2024
…Source/819_add_dodal_nexgen_version_to_release_notes_part_2

819 add dodal and nexgen versions to release notes
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add dodal and nexgen version to release notes
3 participants