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

Prepare release #21

Merged
merged 10 commits into from
Sep 16, 2024
Merged

Prepare release #21

merged 10 commits into from
Sep 16, 2024

Conversation

mbarbin
Copy link
Collaborator

@mbarbin mbarbin commented Sep 10, 2024

Take the opportunity of the next release to revisit a bit some files in the repo. As stated in CHANGES.md:

  • Upgrade to ocamlformat.0.26.2.
  • Fmt the code
  • Add CI badge to README
  • Upgrade GitHub workflow actions dependencies (checkout@v4, setup-ocaml@v3)
  • Add more validation steps in CI
  • Add ocamlformat as dev-setup dependency

- I didn't include `lint-opam` due to issues building `opam-dune-lint`. Left as potential future work.

Signed-off-by: Mathieu Barbin <[email protected]>
Signed-off-by: Mathieu Barbin <[email protected]>
Signed-off-by: Mathieu Barbin <[email protected]>
Signed-off-by: Mathieu Barbin <[email protected]>
@mbarbin
Copy link
Collaborator Author

mbarbin commented Sep 10, 2024

@rgrinberg I have noticed the CI for the Dune project itself (workflow.yml) has a refined include section where you limit the various combinations of arch, os and ocaml versions. Given the CI failures here, I am inclined to add a similar section for the pp project as well. What do you think?

In particular, macos-latest, 4.08.x is not going to work due to the constraint: available: !(os = "macos" & arch = "arm64").

I wondered how that last couple of PRs in this project succeeded. The logs have expired so I wasn't able to look in details, but this target is green in for example #19. (?)

@rgrinberg
Copy link
Contributor

Yeah, that sounds fine. Dropping 4.08 altogether is also fine.

@mbarbin
Copy link
Collaborator Author

mbarbin commented Sep 10, 2024

Dropping 4.08 altogether is also fine.

It wasn't exactly straight forward to do, as 4.09 has the same issue, and various other versions have other build failures.

I attempted to identify the exact set of CI combinations that do not fail at the moment. I did not expect to encounter that many failures, I am not sure if something unusual is happening. Aren't we going to encounter the same failures when ocaml-ci is going to run during the PR validation on opam-repository? Shall some additional constraints be added to the pp.opam file?

Beside these side questions, I think this PR is ready for review.

@mbarbin
Copy link
Collaborator Author

mbarbin commented Sep 10, 2024

@mbarbin assigned @rgrinberg now

I meant to request a review, please disregard.

@@ -1,4 +1,4 @@
(lang dune 1.0)

;; This file is used by `make all-supported-ocaml-versions`
(context (opam (switch 4.08.0)))
(context (opam (switch 4.08.1)))
Copy link
Contributor

Choose a reason for hiding this comment

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

I personally don't use this workspace file. So feel free to delete it unless you're using it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ack, I removed it.

Signed-off-by: Mathieu Barbin <[email protected]>
Skip failures (macsos, windows).

Signed-off-by: Mathieu Barbin <[email protected]>
Signed-off-by: Mathieu Barbin <[email protected]>
@mbarbin
Copy link
Collaborator Author

mbarbin commented Sep 13, 2024

@rgrinberg I noticed creating 'Merge commit' isn't enabled for this repo. What's your preferred mode of operation between 'Squash and merge' and 'Rebase and merge' in general for this repo? For this PR I lean towards keeping the commit history (I cleaned it up a bit), so planning on merging with a 'Rebase and merge'. I'll try creating smaller PR next so 'Squash and merge' can feel more natural. Sounds OK?

@rgrinberg
Copy link
Contributor

If the commit history is useless (individual commits don't build/work), then I prefer squashing. Otherwise squash & merge is fine. I re-enabled it for this repo.

@mbarbin mbarbin merged commit b6741dd into ocaml-dune:master Sep 16, 2024
16 checks passed
@mbarbin mbarbin deleted the prepare-release branch September 16, 2024 07:43
mbarbin added a commit to mbarbin/opam-repository-1 that referenced this pull request Sep 16, 2024
CHANGES:

- Prepare release (ocaml-dune/pp#21, @mbarbin)
  - Upgrade to `ocamlformat.0.26.2`.
  - Fmt the code
  - Add CI badge to README
  - Upgrade GitHub workflow actions dependencies (checkout@v4, setup-ocaml@v3)
  - Add more validation steps in CI
  - Add `ocamlformat` as dev-setup dependency

- Add `Pp.verbatimf`. (ocaml-dune/pp#18, @mbarbin)

- Add `Pp.paragraph` and `Pp.paragraphf` (ocaml-dune/pp#19, @Alizter)

- Remove `of_fmt` constructor. (ocaml-dune/pp#17, @Alizter)
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