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

Update changelog and spec version for v1.2-rc.2 #485

Merged
merged 18 commits into from
Apr 8, 2024
Merged

Conversation

ml-evs
Copy link
Member

@ml-evs ml-evs commented Dec 20, 2023

This PR prepares the v1.2.0 release by updating the changelog and version of the spec.

Closes #429 and closes #433 and closes #412

@rartino rartino added the status/blocked Blocked by other PRs that must be handled first label Jan 10, 2024
@ml-evs ml-evs changed the title Update changelog and spec version for rc.2 Update changelog and spec version for v1.2 Mar 21, 2024
Copy link
Member Author

@ml-evs ml-evs left a comment

Choose a reason for hiding this comment

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

I'll start upgrading this PR to handle the real release rather than rc2 (which I guess we no longer need)

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
optimade.rst Show resolved Hide resolved
@ml-evs ml-evs added the blocking-release This is a PR or issue that presently blocks the release of next version of the spec. label Mar 22, 2024
@ml-evs ml-evs self-assigned this Mar 22, 2024
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@ml-evs ml-evs removed the status/blocked Blocked by other PRs that must be handled first label Mar 25, 2024
@ml-evs ml-evs requested review from rartino and merkys and removed request for rartino and merkys March 25, 2024 17:41
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
@ml-evs ml-evs changed the title Update changelog and spec version for v1.2 Update changelog and spec version for v1.2-rc.2 Apr 4, 2024
@ml-evs ml-evs requested review from merkys and vaitkus April 4, 2024 16:08
CHANGELOG.md Show resolved Hide resolved
vaitkus
vaitkus previously approved these changes Apr 4, 2024
merkys
merkys previously approved these changes Apr 5, 2024
Copy link
Contributor

@rartino rartino left a comment

Choose a reason for hiding this comment

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

Thanks for working on this!

Seeing a slight need to improve clarity only on the item for the license, I was about to approve this and say, fine to release rc.2 as is, but maybe we can get this into the final changelog. However, then I realized that changelog item also didn't link #497, which I think is more important. So, maybe lets get this in?

Also, while I greatly appreciate the addition of https://specification.optimade.org, I'm a bit worried about that I don't see a strategy regarding versioning there. Should we say that https://specification.optimade.org always shows the latest released (or candidate?) specification, and https://specification.optimade.org/v\<version>/ shows the respective versioned ones?

In fact - with the specification not hosted below https://www.optimade.org/ - it may be helpful if we can manage to insert something like a header (like the warning that is there now), or some other kind of "hoverbox" on the specification page to point people to "https://www.optimade.org" for more info, and links to all the other different versions available; a bit like read-the-docs does it.)

CHANGELOG.md Outdated Show resolved Hide resolved
@ml-evs ml-evs dismissed stale reviews from merkys and vaitkus via be4bf87 April 8, 2024 10:23
Co-authored-by: Rickard Armiento <[email protected]>
@ml-evs
Copy link
Member Author

ml-evs commented Apr 8, 2024

However, then I realized that changelog item also didn't link #497, which I think is more important. So, maybe lets get this in?

Yep, fair enough. Sorry for the re-review pings everyone...

Also, while I greatly appreciate the addition of https://specification.optimade.org, I'm a bit worried about that I don't see a strategy regarding versioning there. Should we say that https://specification.optimade.org always shows the latest released (or candidate?) specification, and [https://specification.optimade.org/v](https://specification.optimade.org/v%5C)/ shows the respective versioned ones?

In fact - with the specification not hosted below https://www.optimade.org/ - it may be helpful if we can manage to insert something like a header (like the warning that is there now), or some other kind of "hoverbox" on the specification page to point people to "https://www.optimade.org" for more info, and links to all the other different versions available; a bit like read-the-docs does it.)

This is something I wanted to sort out before the final release. My plan would be to host the latest released version at the canonical https://specification.optimade.org and then have the development version be hosted under https://specification.optimade.org/specification/develop (as it is now). All these changes can be made just by hacking around on the gh-pages branch without need for reviews/PRs here (though perhaps once things are settled we can enforce branch protections on gh-pages too). We can definitely link to the appropriate places from https://www.optimade.org/optimade and add another landing page at https://specification.optimade.org instead of the redirect to the spec.

@ml-evs
Copy link
Member Author

ml-evs commented Apr 8, 2024

We also need to figure out SSL on that subdomain...

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@rartino
Copy link
Contributor

rartino commented Apr 8, 2024

All these changes can be made just by hacking around on the gh-pages branch without need for reviews/PRs here (though perhaps once things are settled we can enforce branch protections on gh-pages too).

Well, I may be reading this overly strict, but thinking about this changelog entry after we've added more releases, that link could be a bit more clear on what precisely the URL links to and/or be updated with version numbers.

We also need to figure out SSL on that subdomain...

Yeah, this actually quite painful, and has required going via netlify due to the certificate setup used by UCLouvain.

Not to undo the fine work with the specification subdomain, but are there good reasons for going with a separate subdomain for this, rather than to create a new 'specification' repo that uses the GitHub pages feature of automatically getting the specifications hosted under https://www.optimade.org/specification ? (Much like, I see that by accident we host the providers page also under https://www.optimade.org/providers ...; maybe we should turn that off.)

It would be nice avoid adding one more subdomain to worry about the SSL certificate renewal of...

@ml-evs
Copy link
Member Author

ml-evs commented Apr 8, 2024

Well, I may be reading this overly strict, but thinking about this changelog entry after we've added more releases, that link could be a bit more clear on what precisely the URL links to and/or be updated with version numbers.

I think for a release candidate this is fine; let's merge as-is and come back to this discussion. Either way it should be clear upon visiting whatever URL we host it at, which version you are viewing; the repo is still the single point of truth for the specification text.

Not to undo the fine work with the specification subdomain, but are there good reasons for going with a separate subdomain for this, rather than to create a new 'specification' repo that uses the GitHub pages feature of automatically getting the specifications hosted under https://www.optimade.org/specification ? (Much like, I see that by accident we host the providers page also under https://www.optimade.org/providers ...; maybe we should turn that off.)

I initially tried to do this, but I think the corresponding URL would be https://www.optimade.org/OPTIMADE rather than /specification, which isn't quite as nice... Feel free to play around with the settings though.

@ml-evs ml-evs merged commit 6d62dce into develop Apr 8, 2024
4 checks passed
@ml-evs ml-evs deleted the ml-evs/rc2_prep branch April 8, 2024 13:07
@rartino
Copy link
Contributor

rartino commented Apr 8, 2024

@ml-evs

I initially tried to do this, but I think the corresponding URL would be https://www.optimade.org/OPTIMADE rather than /specification, which isn't quite as nice... Feel free to play around with the settings though.

Ah, but, is it crucial that the specification(s) webpages are built in a gh_pages of the main OPTIMADE repo, as opposed to another Materials-Consortia repo named 'specification'? I don't think functionality-wise it would be very different?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocking-release This is a PR or issue that presently blocks the release of next version of the spec.
Projects
None yet
4 participants