-
Notifications
You must be signed in to change notification settings - Fork 323
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
Add a belated changelog update with recent OCaml Infrastructure updates #2744
Add a belated changelog update with recent OCaml Infrastructure updates #2744
Conversation
|
||
# Catching up | ||
|
||
[Taride](https://tarides.com/)'s OCaml Infrastructure team has been hard at work |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/Taride/Tarides (I don't know if that's a typo or that how Tarides's is supposed to be written.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thomas decided that any possessive of Tarides should be Tarides'
[opam-ci-check](https://github.com/ocurrent/opam-repo-ci/tree/master/opam-ci-check), | ||
a command line utility aiming to make opam repo CI's logic local-first. It is | ||
still in the early stages and far from finished, but it is enabling faster | ||
development iteration already, and it will soon be fit for early adopting |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can already call it fit for early adopters to test, given that we have added instructions to reproduce locally. (to be deployed soon)?
Thank you for preparing this update on the OCaml infrastructure work! It's great to see all the progress that's been made. I have some feedback to help align this more closely with the OCaml Changelog's intended format and purpose:
Here's an example of what I mean, feel free to discard it, this is more to give a concrete example of the format we could target for the infrastructure updates.
|
tags: [infrastructure] | ||
--- | ||
|
||
# Catching up |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Catching up | |
# Catching Up |
Suggested title case correction
|
||
# Catching up | ||
|
||
[Taride](https://tarides.com/)'s OCaml Infrastructure team has been hard at work |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Taride](https://tarides.com/)'s OCaml Infrastructure team has been hard at work | |
[Tarides'](https://tarides.com/) OCaml Infrastructure team has been hard at work |
over the last months, focused on sustaining the existing systems and | ||
regenerating our team's capacities. This work is in preparation for more | ||
substantive changes to improve the reliability and scalability of essential | ||
OCaml ecosystem infrastructure. We will have more fruits from this work to share | ||
soon, but updates on our efforts are overdue and we wanted to get you all caught | ||
up. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
over the last months, focused on sustaining the existing systems and | |
regenerating our team's capacities. This work is in preparation for more | |
substantive changes to improve the reliability and scalability of essential | |
OCaml ecosystem infrastructure. We will have more fruits from this work to share | |
soon, but updates on our efforts are overdue and we wanted to get you all caught | |
up. | |
over the last few months, focused on sustaining the existing systems and | |
regenerating our team's capacities. This work is in preparation for more | |
substantive changes to improve the reliability and scalability of essential | |
OCaml ecosystem infrastructure. We will have more fruit from this work to share | |
soon, but updates on our efforts are overdue and we wanted to get you all caught | |
up. |
Minor language usage corrections
|
||
Since we last published an announcement, we have been... | ||
|
||
## making the systems more stable |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## making the systems more stable | |
## Making the Systems More Stable |
in the opam repo CI (by [@shonfeder](https://github.com/shonfeder), see | ||
[ocurrent/opam-repo-ci#341](https://github.com/ocurrent/opam-repo-ci/pull/341). | ||
|
||
## keeping the systems up to date |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## keeping the systems up to date | |
## Keeping the Systems Up to Date |
|
||
- Dropped support for the post-LTS distro versions Debian 10 and 11 (by | ||
[@mtelvers](https://github.com/mtelvers) and | ||
[@shonfeder](https://github.com/shonfeder) see |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[@shonfeder](https://github.com/shonfeder) see | |
[@shonfeder](https://github.com/shonfeder), see |
- There was a profusion of solver timeout errors impacting the opam repo CI | ||
system, and we have managed to mitigate these (by | ||
[@mtelvers](https://github.com/mtelvers) and | ||
[@shonfeder](https://github.com/shonfeder) see |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[@shonfeder](https://github.com/shonfeder) see | |
[@shonfeder](https://github.com/shonfeder), see |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly minor formatting, capitalisation, and grammar fixes...so apologies for the noise! I usually edit little things like this directly, but I don't have write access on this. If you'd like to give it to me, I can make these changes without disrupting the conversation too much. 🙂
and | ||
[ocurrent/ocaml-dockerfile#210](https://github.com/ocurrent/ocaml-dockerfile/pull/210)). | ||
|
||
## making it easier to understand the systems |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## making it easier to understand the systems | |
## Making It Easier to Understand the Systems |
[services]: https://github.com/ocurrent/ocurrent-deployer/blob/master/doc/services.md | ||
[platforms]: https://github.com/ocurrent/opam-repo-ci/blob/master/doc/platforms.md | ||
|
||
## improving the functionality and usability of the systems |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## improving the functionality and usability of the systems | |
## Improving the Functionality and Usability of the Systems |
## improving the functionality and usability of the systems | ||
|
||
- We have been developing | ||
[opam-ci-check](https://github.com/ocurrent/opam-repo-ci/tree/master/opam-ci-check), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[opam-ci-check](https://github.com/ocurrent/opam-repo-ci/tree/master/opam-ci-check), | |
[`opam-ci-check`](https://github.com/ocurrent/opam-repo-ci/tree/master/opam-ci-check), |
and | ||
[ocurrent/opam-repo-ci#360](https://github.com/ocurrent/opam-repo-ci/issues/360)). | ||
|
||
# Forging ahead |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Forging ahead | |
# Forging Ahead |
@tmattio Thanks for the review.
What effect does this have? |
It displays a "See full changelog" button at the bottom of the post, which displays the content of the field, see for instance https://ocaml.org/changelog/2024-07-31-ocaml-lsp-1.19.0 |
I see, thanks! I would note, IMO generating documentation of what we are testing and deploying is likely to be of direct value to users. Also, I suggest expanding the contributing section with the kinds of guidelines you've shared here, as I consulted that before opening this PR, and all it says is
Stipulating the stylistic and content constraints there (along with providing a template somewhere) would help with the process we discussed. |
I adopted @tmattio's preferred presentation with minor changes and additions. I also tried to preserve all of @christinerose's fixes.
I don't have permissions to grant you write access to ocaml.org, sorry. But your suggestions and corrections are most welcome and not noise. |
Thank you for saying so! ❤️ |
Thanks a lot! I'll add these guidelines to the contributing guide in a separate PR |
Thanks for review, feedback, guidance :) Unfortunately, it looks like this was deployed despite the CI check on this branch failing (https://github.com/ocaml/ocaml.org/actions/runs/11182816793/job/31089951473) and as a result the same (inscrutable) error has broken the deployment https://deploy.ci.ocaml.org/job/2024-10-04/161841-ocluster-build-376c36 I would suggest enabling branch protection rules on this repo (and just in general). (I'm trying to figure out why the post broke the build and how to fix it.) |
Fixes several errors in the meta-data from ocaml#2744 . These broke the build with uncaught exceptions such as ``` Ood_gen.Exn.Decode_error("data/changelog/infra/2024-10-02-updates.md : error calling parser: mapping values are not allowed in this context character 0 position 0 returned: 0") ``` and ``` Ood_gen.Exn.Decode_error("data/changelog/infra/2024-10-02-updates.md : data/changelog/infra/2024-10-02-updates.md : date2024-10-04\n") ``` Also added the infrastructure tag that had been lost during review.
Fixes several errors in the meta-data from #2744 . These broke the build with uncaught exceptions such as ``` Ood_gen.Exn.Decode_error("data/changelog/infra/2024-10-02-updates.md : error calling parser: mapping values are not allowed in this context character 0 position 0 returned: 0") ``` and ``` Ood_gen.Exn.Decode_error("data/changelog/infra/2024-10-02-updates.md : data/changelog/infra/2024-10-02-updates.md : date2024-10-04\n") ``` Also added the infrastructure tag that had been lost during review.
Requested by @rikusilvola and @tmattio, and in accordance with our discussion today about improving the cadence and regularity of changelog updates.
This is an unusually long entry, relative to past entries and what you can expect from us in the future. That is only because we are making up for a lapse in external communication.
In ocaml/infrastructure#159 we will be announcing the plan to shift to using the ocaml changelog as our main venue for updates.
It's my first time writing one of these, so please let me know if the content or tone should be adjusted.
cc @mtelvers, @cuihtlauac (since I cannot request you are reviewers :)).