Skip to content

v2.1.0

Choose a tag to compare

@blueraft blueraft released this 03 Nov 13:02
· 31 commits to main since this release
47867b6

What's Changed

Automated Unit and Example Upload Tests in CI

By default, all unit tests from every plugin are executed to ensure system stability and catch potential issues early. These tests validate core functionality and help maintain consistency across different plugins.

In addition to unit tests, the pipeline also verifies that all example uploads can be processed correctly. This ensures that any generated entries do not contain error messages, providing confidence that data flows through the system as expected.

For example upload tests, the CI uses the image built in the Build Image step. It then runs the Docker container and starts up the application to confirm that it functions correctly. This approach ensures that if the pipeline passes, the app is more likely to run smoothly in a Dockerized environment on a server, not just locally.

If you need to disable tests for specific plugins, update the PLUGIN_TESTS_PLUGINS_TO_SKIP variable in .github/workflows/docker-publish.yml by adding the plugin names to the existing list.

Set Up Regular Package Updates with Dependabot

Dependabot is already configured in the repository’s CI setup, but you need to enable it manually in the repository settings.

To enable Dependabot, go to Settings > Code security and analysis in your GitHub repository. From there, turn on Dependabot alerts and version updates. Once enabled, Dependabot will automatically check for dependency updates and create pull requests when new versions are available.

This automated process helps ensure that your dependencies stay up to date, improving security and reducing the risk of vulnerabilities.

Customizing Documentation

By default, documentation is built using the nomad-docs repository. However, if you'd like to customize the documentation for your Oasis instance, you can easily do so.

This setup ensures that your custom documentation is used when building your Oasis.

Updating the distribution from the template

   git remote add template https://github.com/FAIRmat-NFDI/nomad-distro-template
   git fetch template
   git merge v2.1.0 --allow-unrelated-histories

Most likely this will result in some merge conflicts which will need to be resolved. At the very least the Dockerfile and GitHub workflows should be taken from "theirs":

   git checkout --theirs Dockerfile
   git checkout --theirs .github/workflows/docker-publish.yml

You can choose to keep your docker-compose.yamland lock file uv.lock:

   git checkout --ours docker-compose.yaml
   git checkout --ours uv.lock

New Contributors

Full Changelog: v2.1.0...v2.2.0