Skip to content

v0.5.0 - FeastySplicingViper: Docs in Harmony🐍

Choose a tag to compare

View all tags
@johausmann johausmann released this 02 Jul 09:37
v0.5.0
9d77a5d

NeoRasp v0.5.0 - FeastySplicingViper: Docs in Harmony🐍

The viper got wiser: cleaner docs, cleaner docstrings, smoother splices.”

This release introduces several improvements to documentation, repository configuration, and workflow management for the NeoRasp pipeline. The main changes include a comprehensive update of the README.md, addition of contribution guidelines, improved documentation structure, and updates to CI/CD and configuration files.

What's Changed

Documentation updates:

  • Rewrite and reorganization of README.md to clarify installation, usage, input/output, and contribution instructions, and to update links and references for the GitHub repository.
  • Addition of CONTRIBUTING.md with clear guidelines for contributing, including documentation and pipeline module development.
  • Addition and update of documentation files in documentation/neorasp/docs/, including about.md, faq.md, installation.md, and references.md, with improved instructions, FAQ entries, and updated references.
  • Updates to developer guide and cluster documentation to fix links, clarify plugin usage

CI/CD and Workflow Configuration:

  • Addition of a path filter to the CI workflow (.github/workflows/ci.yml) to skip pipeline runs for documentation-only changes.
  • Removal of the legacy release-please.yaml workflow.

Configuration Updates:

  • Addition of a config validation schema which provides default values for test runs, allowing to drop example configs.
  • Addition of a usage section to .snakemake-workflow-catalog.yml to clarify supported deployment methods.

Catalog Updates:

  • Addition of a usage section to .snakemake-workflow-catalog.yml to clarify supported deployment methods.
Assets 2
Loading