Skip to content

Commit

Permalink
Fix: #248 RN update, tag and publish docs for v4.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
shaloo committed May 4, 2024
1 parent 1c23ac9 commit 35492d4
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.5.0
4.6.0
1 change: 1 addition & 0 deletions docs/source/development/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The current release of GenPipes is |genpipes_version|.

Following links point to the recent GenPipes release notes.

* :ref:`GenPipes 4.6.0<docs_gp_relnote_4_6_0>` released on May 1, 2024
* :ref:`GenPipes 4.5.0<docs_gp_relnote_4_5_0>` released on Feb 10, 2024
* :ref:`GenPipes 4.4.5<docs_gp_relnote_4_4_5>` released on Nov 14, 2023
* :ref:`GenPipes 4.4.4<docs_gp_relnote_4_4_4>` released on Sept 11, 2023
Expand Down
57 changes: 57 additions & 0 deletions docs/source/development/relnotes/gp_4_6_0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
:orphan:

.. _docs_gp_relnote_4_6_0:

.. spelling::

genpipes

GenPipes 4.6.0 Release Notes
============================

What's new?
-----------

This is a medium release with bug-fixes:

* General for all pipelines:
- Fixed an issue with using `zless` by replacing it with `zcat`. This issue recently appeared on alliance clusters and may have been related to the upgrades to the StdEnv module. We encourage all users working on alliance clusters to use the new version of GenPipes!
* `Amplicon Sequencing Pipeline <https://bitbucket.org/mugqic/genpipes/src/4.6.0/pipelines/ampliconseq/>`_ :
- Bug fixes and improved module loading in `qiime` protocol
* `Methyl Sequencing Pipeline <https://bitbucket.org/mugqic/genpipes/src/4.6.0/pipelines/methylseq/>`_ :
- Reverted **BisSNP** to v.0.82.2 because v.1.0.0 was outputting malformed vcf files
- Added gzipping of BisSNP output files
* `Tumor Pair Pipeline <https://bitbucket.org/mugqic/genpipes/src/4.6.0/pipelines/tumor_pair/>`_ :
- Fixed a bug with PCGR when pair name is longer than 35 characters
- Improved restarts
* `RNA Sequencing Pipeline <https://bitbucket.org/mugqic/genpipes/src/4.6.0/pipelines/rnaseq/>`_ :
- Fixed a bug with **PCGR** when sample name is longer than 35 characters
- Minor changes to resource requests for improving efficiency
* `Chip Sequencing Pipeline <https://bitbucket.org/mugqic/genpipes/src/4.6.0/pipelines/chipseq/>`_ :
- Fixed an error that caused the same blacklist file to be used regardless of species and genome version specified. Use of a blacklist is now optional and users can now specify their desired blacklist file in their config file.
* `Cov Sequencing Pipeline <https://bitbucket.org/mugqic/genpipes/src/4.6.0/pipelines/covseq/>`_ :
- The default version of amplicon scheme is now updated to v.5.3.2
- The `pandoc` version for report generation to 2.16.2

Quick! Where can I find it? I can't wait!
------------------------------------------

* The latest release for GenPipes version 4.6.0 tarball is in: https://bitbucket.org/mugqic/genpipes/downloads/genpipes-4.6.0.tar.gz

* The module mugqic/genpipes/4.6.0 is installed on AAbacus (MGC), Béluga, Graham, Cedar and Narval Compute Canada clusters.

* The source code is in bitbucket: https://bitbucket.org/mugqic/genpipes

* For latest GenPipes documentation, please refer to: https://genpipes.readthedocs.io/

Where is the detailed ChangeLog?
=================================

A ChangeLog (`CHANGELOG.md <https://bitbucket.org/mugqic/genpipes/src/master/CHANGELOG.md>`_) is available in the archive as well as in the repository.

Since we use git, there are many ways to get the details in many formats.

One of our preferred ways is to use `a script <https://raw.github.com/sebhtml/ray/master/scripts/dump-ChangeLog.sh>`_ written by the author of the Ray assembler: Sébastien Boisvert, which lists the commits by tag and author.

Enjoy our pipelines installed on the many Compute Canada clusters!
We look forward to your feedback!

0 comments on commit 35492d4

Please sign in to comment.