Merge hotfixes into devel

[t-ramz]

PR Description

Various fixes for configuration have gone into the release branch, and should be sync'd back into devel

Tasks

• - A description of the PR has been provided, and a diagram included if it is a new feature.
• - Formatter has been run
• - CHANGELOG comment has been added
• - Labels have been assigned to the pr
• - A reviwer has been added
• - A user has been assigned to work on the pr
• - If new feature a unit test has been added

Summary by Sourcery

Syncs various fixes from the release branch back into devel, including configuration fixes, version updates, and CI improvements. The changes ensure that the latest configuration and build settings are applied across the project.

Bug Fixes:

• Fixes an issue where core config threads were not being set via environment variables.

Enhancements:

• Updates the datafed-repo.cfg generation script to use the DATAFED_SERVER_PORT environment variable if it is set, defaulting to 7512 otherwise.

Build:

• Updates the project's versioning information in cmake/Version.cmake.
• Removes the format check workflow from .github/workflows/format-check.yml.
• Adds the --no-cache flag to docker build commands in the CI pipeline to prevent caching issues.

CI:

• Updates the CI pipeline to use docker system prune -f --all to remove all unused images and containers.
• Updates the .gitlab-ci.yml files to trigger builds on cmake changes.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request merges hotfixes from the release branch into the development branch. It updates version numbers, modifies configuration scripts to utilize environment variables, disables Docker cache during image builds, and includes other minor fixes and updates.

Sequence diagram for generating core config

sequenceDiagram
  participant Script
  participant Environment

  Script->>Environment: Check if DATAFED_CORE_CLIENT_THREADS is set
  alt DATAFED_CORE_CLIENT_THREADS is not set
    Script->>Script: Set local_DATAFED_CORE_CLIENT_THREADS to default "2"
  else DATAFED_CORE_CLIENT_THREADS is set
    Script->>Environment: Get DATAFED_CORE_CLIENT_THREADS value
    Environment-->>Script: Returns DATAFED_CORE_CLIENT_THREADS value
    Script->>Script: Set local_DATAFED_CORE_CLIENT_THREADS to DATAFED_CORE_CLIENT_THREADS value
  end

  Script->>Environment: Check if DATAFED_CORE_TASK_THREADS is set
  alt DATAFED_CORE_TASK_THREADS is not set
    Script->>Script: Set local_DATAFED_CORE_TASK_THREADS to default "2"
  else DATAFED_CORE_TASK_THREADS is set
    Script->>Environment: Get DATAFED_CORE_TASK_THREADS value
    Environment-->>Script: Returns DATAFED_CORE_TASK_THREADS value
    Script->>Script: Set local_DATAFED_CORE_TASK_THREADS to DATAFED_CORE_TASK_THREADS value
  end

Loading

Sequence diagram for generating repo config

sequenceDiagram
  participant Script
  participant Environment

  Script->>Environment: Check if DATAFED_DOMAIN is set
  alt DATAFED_DOMAIN is not set
    Script->>Script: Set local_DATAFED_DOMAIN to default "datafed.ornl.gov"
  else DATAFED_DOMAIN is set
    Script->>Environment: Get DATAFED_DOMAIN value
    Environment-->>Script: Returns DATAFED_DOMAIN value
    Script->>Script: Set local_DATAFED_DOMAIN to DATAFED_DOMAIN value
  end

  Script->>Environment: Check if DATAFED_DEFAULT_LOG_PATH is set
  alt DATAFED_DEFAULT_LOG_PATH is not set
    Script->>Script: Set local_DATAFED_LOG_PATH to default "/tmp/datafed/"
  else DATAFED_DEFAULT_LOG_PATH is set
    Script->>Environment: Get DATAFED_DEFAULT_LOG_PATH value
    Environment-->>Script: Returns DATAFED_DEFAULT_LOG_PATH value
    Script->>Script: Set local_DATAFED_LOG_PATH to DATAFED_DEFAULT_LOG_PATH value
  end

  Script->>Environment: Check if DATAFED_SERVER_PORT is set
  alt DATAFED_SERVER_PORT is not set
    Script->>Script: Set local_DATAFED_SERVER_PORT to default "7512"
  else DATAFED_SERVER_PORT is set
    Script->>Environment: Get DATAFED_SERVER_PORT value
    Environment-->>Script: Returns DATAFED_SERVER_PORT value
    Script->>Script: Set local_DATAFED_SERVER_PORT to DATAFED_SERVER_PORT value
  end

Loading

Updated class diagram for Version.cmake

classDiagram
  class Version {
    DATAFED_RELEASE_YEAR
    DATAFED_RELEASE_MONTH
    DATAFED_RELEASE_DAY
    DATAFED_RELEASE_HOUR
    DATAFED_RELEASE_MINUTE
    DATAFED_COMMON_LIB_MAJOR
    DATAFED_COMMON_LIB_MINOR
    DATAFED_COMMON_LIB_PATCH
    DATAFED_COMMON_PROTOCOL_API_MAJOR
    DATAFED_COMMON_PROTOCOL_API_MINOR
    DATAFED_COMMON_PROTOCOL_API_PATCH
    DATAFED_CORE_MAJOR
    DATAFED_CORE_MINOR
    DATAFED_CORE_PATCH
    DATAFED_FOXX_MAJOR
    DATAFED_FOXX_MINOR
    DATAFED_FOXX_PATCH
    DATAFED_FOXX_API_MAJOR
    DATAFED_FOXX_API_MINOR
    DATAFED_FOXX_API_PATCH
    DATAFED_WEB_MAJOR
    DATAFED_WEB_MINOR
    DATAFED_WEB_PATCH
    DATAFED_REPO_MAJOR
    DATAFED_REPO_MINOR
    DATAFED_REPO_PATCH
    DATAFED_AUTHZ_MAJOR
    DATAFED_AUTHZ_MINOR
    DATAFED_AUTHZ_PATCH
    DATAFED_PYTHON_CLIENT_MAJOR
    DATAFED_PYTHON_CLIENT_MINOR
    DATAFED_PYTHON_CLIENT_PATCH
    DATAFED_PYTHON_CLIENT_RELEASE_TYPE
    DATAFED_PYTHON_CLIENT_PRE_RELEASE_IDENTIFER
  }
  note for Version "Version numbers have been updated."

Loading

File-Level Changes

Change	Details	Files
Updates the release date and version numbers for various DataFed components.	Updates the release year to 2025. Updates the release month to February. Updates the release day to the 16th. Updates the release hour to 21. Updates the release minute to 15. Increments the patch version for DATAFED_COMMON_LIB to 1. Increments the minor version for DATAFED_COMMON_PROTOCOL_API to 1. Increments the patch version for DATAFED_CORE to 2. Increments the minor version for DATAFED_FOXX to 1. Increments the minor version for DATAFED_FOXX_API to 1. Increments the minor version for DATAFED_WEB to 1 and decrements the patch version to 0. Increments the patch version for DATAFED_AUTHZ to 1. Increments the patch version for DATAFED_PYTHON_CLIENT to 3 and removes the prerelease identifier.	cmake/Version.cmake
Modifies shell scripts to use environment variables for configuration and sets a default value for the server port.	In generate_core_config.sh, the script now checks if DATAFED_CORE_CLIENT_THREADS and DATAFED_CORE_TASK_THREADS are set as environment variables, and uses them if available, defaulting to "2" if not. In generate_repo_config.sh, the script now checks if DATAFED_SERVER_PORT is set as an environment variable, and uses it if available, defaulting to "7512" if not.	scripts/generate_core_config.sh scripts/generate_repo_config.sh
Updates GitLab CI configuration to disable the docker cache during image builds and to prune all images during cache clearing.	Adds the --no-cache flag to the docker build commands in .gitlab/common.yml to prevent using cached layers during image builds. Adds the --all flag to the docker system prune -f command in .gitlab/stage_clear_cache.yml to remove all unused images, not just dangling ones.	.gitlab/common.yml .gitlab/stage_clear_cache.yml
Updates the changelog and build configurations.	Adds a changelog entry for allowing core config threads via environment variables. Fixes a typo in the changelog entry for Jupyter Notebooks. Adds cmake/**/* to the changes list for the foxx and ws image builds.	CHANGELOG.md .gitlab/build/build_foxx_image.yml .gitlab/build/build_ws_image.yml
Updates the GCS base image build process to disable the docker cache.	Adds the --no-cache flag to the docker build command in .gitlab/build/build_gcs_base_image.yml and .gitlab/build/force_build_gcs_base_image.yml to prevent using cached layers during image builds.	.gitlab/build/build_gcs_base_image.yml .gitlab/build/force_build_gcs_base_image.yml
Updates the GCS image build process to disable the docker cache.	Adds the --no-cache flag to the docker build command in .gitlab/build/force_build_gcs_image.yml to prevent using cached layers during image builds.	.gitlab/build/force_build_gcs_image.yml
Removes the format check workflow.	Removes the format check workflow.	.github/workflows/format-check.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @t-ramz - I've reviewed your changes - here's some feedback:

Overall Comments:

• The removal of the format-check.yml workflow seems like a significant change; can you confirm that formatting will still be checked?
• The addition of --no-cache to the docker build commands is a good way to ensure that the images are rebuilt from scratch, but it will increase build times.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}