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

add codespaces-configuration #87

Merged
merged 19 commits into from
Dec 11, 2023
Merged

add codespaces-configuration #87

merged 19 commits into from
Dec 11, 2023

Conversation

ptahmose
Copy link
Contributor

@ptahmose ptahmose commented Dec 9, 2023

Description

Adding a .devcontainer folder with some default configuration. This should allow to build libCZI (including CZICmd and with libcurl-support) right from the start (depending on #86).

The only modifications of the boilerplate code (c.f. here) we made are:

  • we install some apt packages (within Dockerfile)
  • we configure VSCode to use some switches for the CMake-configure run which instruct to build libCZI/CZICmd with "all availabile features"

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Checklist:

  • I followed the Contributing Guidelines.
  • I did a self-review.
  • I commented my code, particularly in hard-to-understand areas.
  • I updated the documentation.
  • I updated the version of libCZI following Versioning of libCZI depending on the type of change
    • Bug fix -> PATCH
    • New feature -> MINOR
    • Breaking change -> MAJOR
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

Signed-off-by: ptahmose <jbohl@h-quer.de>
Signed-off-by: ptahmose <jbohl@h-quer.de>
Signed-off-by: ptahmose <jbohl@h-quer.de>
Signed-off-by: ptahmose <jbohl@h-quer.de>
Signed-off-by: ptahmose <jbohl@h-quer.de>
@ptahmose ptahmose added the cla Contributor License Agreement sent to Admin label Dec 9, 2023
@ptahmose ptahmose requested review from DaveyJonesBitPail and a team December 9, 2023 16:31
@ptahmose ptahmose marked this pull request as ready for review December 9, 2023 16:31
Copy link

codecov bot commented Dec 9, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9affb0e) 65.38% compared to head (b1fe80e) 65.38%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #87   +/-   ##
=======================================
  Coverage   65.38%   65.38%           
=======================================
  Files          83       83           
  Lines       10621    10621           
=======================================
  Hits         6945     6945           
  Misses       3676     3676           
Flag Coverage Δ
windows-latest 65.38% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sdierg
Copy link
Contributor

sdierg commented Dec 11, 2023

Adding a .devcontainer file would imply to encourage the use of a docker container fo VS code. So I would have expected an adaption in the "how-to-build" documentation.
The rest looks fine for me, but I did not try it. I really like the approach using docker containers with VS code for C++ development.

Now we are one step from building (and maintaining) containers for building (locally and in pipelines)...

sdierg
sdierg previously approved these changes Dec 11, 2023
Copy link
Contributor

@sdierg sdierg left a comment

Choose a reason for hiding this comment

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

As I did not try and only had a coarse look, my suggestion is to wait at least for one other review.
Please see my comment on the build documentation.

Copy link
Contributor

@DaveyJonesBitPail DaveyJonesBitPail left a comment

Choose a reason for hiding this comment

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

I think it looks good. We may want to add some extra extensions / features in the future (like cmantic or clangd) but everything that is installed in the base image should work pretty well.

@ptahmose ptahmose merged commit 2539ce5 into ZEISS:main Dec 11, 2023
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla Contributor License Agreement sent to Admin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants