search

airr-community / airr-standards

AIRR Community Data Standards
https://docs.airr-community.org
Creative Commons Attribution 4.0 International
35 stars 23 forks source link

version number in spec files is not correct for 1.5.x #783

Closed schristley closed 1 month ago

schristley commented 2 months ago

Both of the AIRR schema spec files say "1.4" when should be "1.5".

Because the master branch has already moved significantly towards 2.0, I've created a release-1.5 branch starting from the v1.5.1 tag according to our release processes. This branch won't get merged to master but will stay in case minor fixes need to be done for the 1.5.x release chain.

schristley commented 2 months ago

@javh If the release-1.5 branch looks ok to you, and nothing else is missing, we should tag it with v1.5.2 and push a release.

schristley commented 2 months ago

@bcorrie My understanding is that CRWG decided not to move the ADC API forward to v1.5.x? Is that true, or should we also update the ADC API specs to point to v1.5.2 and include in the release?

javh commented 2 months ago

@schristley, this looks good to me. Technically, there is a change to the specs so we should release new versions of the R and python packages to CRAN and PyPI. But, it's so minor I'm kind of inclined to skip that step and just do a GitHub release only.

Thoughts?

schristley commented 2 months ago

@javh I think that's ok. For me it's the GitHub tag/release and version number correction that's most important. I suppose we can always do the R and python packages later if people request it.

javh commented 2 months ago

Sounds good to me. I'll make the draft release and email the working group to confirm.

javh commented 2 months ago

I was making the draft release (in https://github.com/airr-community/airr-standards/releases) and I think we may have a problem with our release tags. v1.5.1, v1.4.2, and v1.4.1-beta don't seem to be actual releases, but instead tags that snuck in with PRs.

Meaning, the release-1.5 maintenance branch should start from the v1.5.0 tag and we should remove those extra tags from the repo.

Can you take a look at confirm? If I'm correct, it's at least easy to fix.

schristley commented 2 months ago

Yeah, those tags look odd, as in they don't have a release associated with them. v1.4.2 is suspect as it's between v1.5.0 and v1.5.1. and v1.4.1-beta doesn't sound like a real release either. I guess you are saying that v1.5.1 never happened either, makes sense as I don't see any v1.5.1 release notes.

Yeah, looking at the commits between v1.5.0 and v1.5.1, there is a bunch of v2.0 stuff in there, we don't want that. You are right, should delete the release-1.5 branch and re-branch it off of v1.5.0.

javh commented 2 months ago

Sounds good. We'll need to nuke all those rogue tags too.

schristley commented 2 months ago

Ok, regenerated release-1.5 branch and removed those rogue tags. Also setup branch protections and checks.

I have a version of the airr-js package because I need to use it with v1.5 until v2.0 is released and I'm able to move it.

schristley commented 2 months ago

@javh skip v1.5.1 and leave as v1.5.2, or change your draft release?

javh commented 2 months ago

I'll change the draft release.

javh commented 1 month ago

I looked through the branch and it looks ready to go to me except for:

I'll take care of those after the wg call today and do the release.

But, one thing... Adding the js package seems much bigger than a patch release. I don't have an objection, but what do you think about making the release v1.6.0 (still off the release-1.5 branch)?

schristley commented 1 month ago

Up to you, I’m fine with just updating the patch number for software if the schema hasn’t changed

javh edit: remove email headers

schristley commented 1 month ago

@javh If you want to pedantic about it, even though the js package seems to add a bunch, it's only a patch release.

javh commented 1 month ago

I think we might want to add a python release to this with the versioneer fix (#744).

schristley commented 1 month ago

@javh I think you must have those bogus tags in your local git because when you pushed your commits on Wednesday, those tags came back

schristley commented 1 month ago

I only know this because of the messages posted to the slack channel, otherwise I don't know how to see tag history through the GitHub gui.

12:52 Tag created by javh v1.5.1 https://github.com/[airr-community/airr-standards](https://github.com/airr-community/airr-standards)|airr-community/airr-standardsairr-community/airr-standards

javh commented 1 month ago

Crap. I'll fix it. Thanks.

javh commented 1 month ago

Okay, I've copied over the versioneer changes, decided on v1.5.1, updated the news, and done a basic install test on the python library. The branch should be ready to go.

I still need to sanity check the docs before publishing the release, but I'm about to get on a plane. :)

I'll try to wrap this up as soon as I get a chance.

javh commented 1 month ago

v1.5.1 release is done and I pushed the python package to PyPI. I did not update the R package in CRAN, as there were no functional changes.