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

Isolate test dependencies and update docs #105

Merged
merged 10 commits into from
Nov 3, 2023

Conversation

nberth
Copy link
Collaborator

@nberth nberth commented Nov 2, 2023

This PR primarily updates the documentation on how to build from sources and install the VSCode extension.

As a bonus, dependencies that are only needed for tests are removed from library and program packages, and gathered into a separate superbol-testdeps package (for now, managed manually, i.e outside of drom's realm). This effectively means that make build-deps should not install autofonce_lib or other test-related PPXs anymore. From now on, make dev-deps is needed to install them.

Changes also include the creation of a virtual superbol-studio-oss package that depends on both the LSP server and the VSCode extension (for clarity), and removal of obsolete opam files.

@nberth nberth force-pushed the update-build-docs branch 2 times, most recently from 936d280 to a594a13 Compare November 2, 2023 09:06
Moves the corresponding opam file to `test/opam`.  This effectively
removes a build-dependency to `autofonce_lib`, that should only be
needed for development (installed via `make dev-deps`).

Also move all test dependency declarations to
`test/opam/superbol_testutils.opam`, now also considered by
`dev-deps`.

Remove dependency to `ocamlformat`, that we don't use.
@nberth nberth force-pushed the update-build-docs branch from a594a13 to cfe3625 Compare November 2, 2023 10:01
@nberth nberth force-pushed the update-build-docs branch from 8e9337e to 60ac3aa Compare November 2, 2023 10:35
@nberth nberth requested a review from lefessan November 2, 2023 10:37
@nberth nberth added documentation Improvements or additions to documentation ok to review As its name says labels Nov 2, 2023
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Co-authored-by: Basile Clément <129742207+bclement-ocp@users.noreply.github.com>
@nberth nberth force-pushed the update-build-docs branch from 6b56d23 to a5580b7 Compare November 2, 2023 20:43
@nberth nberth force-pushed the update-build-docs branch from a5580b7 to f503a69 Compare November 2, 2023 21:30
@nberth nberth merged commit 15572bf into OCamlPro:master Nov 3, 2023
3 checks passed
@nberth nberth deleted the update-build-docs branch November 3, 2023 10:18
Copy link
Contributor

@GitMensch GitMensch left a comment

Choose a reason for hiding this comment

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

just some notes (will later try to update the gitpod configuration using the new instructions, but that will likely take some days...)

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ok to review As its name says
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants