Skip to content

Commit f6e9867

Browse files
yashpatel6github-actions[bot]
authored andcommitted
Update CHANGELOG for version 5.2.0
1 parent 1ebe452 commit f6e9867

File tree

2 files changed

+46
-29
lines changed

2 files changed

+46
-29
lines changed

CHANGELOG.md

+45-28
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,71 @@
11
# Changelog
2+
23
All notable changes to the PipeVal tool.
34

45
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
56

67
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
78

8-
---
9+
## [5.2.0] - 2025-02-10
910

10-
## [Unreleased]
1111
### Changed
12+
1213
- Update `pysam` version to `0.22.1`
14+
1315
### Fixed
16+
1417
- MIME types to support older designations
1518
- Error message printing to log
16-
---
1719

1820
## [5.1.0] - 2024-07-08
21+
1922
### Added
23+
2024
- Add validation flowchart
2125
- Add support for unmapped BAM
2226
- Add additional MIME type for GZIP compressed files
2327
- Add support for checksum files formatted with any whitespace separator
2428

25-
---
26-
2729
## [5.0.0] - 2024-02-16
30+
2831
### Added
29-
- Validation skip functionality for checksums
3032

31-
---
33+
- Validation skip functionality for checksums
3234

3335
## [5.0.0-rc.3] - 2023-12-07
36+
3437
### Added
35-
- Integrity test for compressed files
3638

37-
---
39+
- Integrity test for compressed files
3840

3941
## [5.0.0-rc.2] - 2023-12-06
42+
4043
### Added
41-
- FASTQ validator
4244

43-
---
45+
- FASTQ validator
4446

4547
## [5.0.0-rc.1] - 2023-11-22
48+
4649
### Changed
47-
- Restructured CLI to have common main command `pipeval`
4850

49-
---
51+
- Restructured CLI to have common main command `pipeval`
5052

5153
## [4.0.0] - 2023-11-22
54+
5255
### Added
53-
- Parallelize validation
5456

55-
---
57+
- Parallelize validation
5658

5759
## [4.0.0-rc.2] - 2023-04-24
60+
5861
### Changed
59-
- Resolve potential symlinks before validation
6062

61-
---
63+
- Resolve potential symlinks before validation
6264

6365
## [4.0.0-rc.1] - 2023-04-11
66+
6467
### Added
68+
6569
- Add check for empty BAM files (valid header but no reads).
6670
- Add auto-build workflow to push image to `uclahs-cds` registry
6771
- Add repo source label to Dockerfile
@@ -73,6 +77,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
7377
- Compression validation and detection through `python-magic`
7478

7579
### Changed
80+
7681
- Make `-t` optional, default to `file-input`
7782
- Explicitly set Python version to `3.10`
7883
- Split validation and checksum generation into different CLI commands
@@ -81,38 +86,50 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
8186
- Update README input tables and command examples
8287
- Re-structure README with details of current tool
8388

84-
### Fixed
85-
8689
### Removed
90+
8791
- Remove deprecated parameter options from README
8892
- Remove inaccessible design doc link from README
8993
- Remove directory checking
9094
- Remove user-specified file type option
9195

92-
---
93-
9496
## [3.0.0] - 2022-08-03
95-
### Updated
96-
- Updated bl-base to 1.1.0
97-
- Installed tools using `mamba`
9897

9998
### Added
99+
100100
- Add `bldocker` user and group to Dockerfile
101101
- Add support for mutliple input files
102102

103103
### Changed
104+
105+
- Updated bl-base to 1.1.0
106+
- Installed tools using `mamba`
104107
- Convert module to Python CLI package; now runs directly from commandline with `validate`.
105-
- Single source package version from \_\_init__.py
108+
- Single source package version from \_\_init\_\_.py
106109
- Use `pysam` instead of `samtools` in bam file validation.
107110

108111
### Fixed
109-
- Add handling for valid file types whose validation is not yet implemented.
110112

111-
---
113+
- Add handling for valid file types whose validation is not yet implemented.
112114

113115
## [2.1.6] - 2021-10-18
116+
114117
### Changed
115-
- File type detection update to properly detect file type when filename contains multiple .
118+
119+
- File type detection update to properly detect file type when filename contains multiple .
116120

117121
### Fixed
122+
118123
- Fixed bug with detecting fasta files
124+
125+
[2.1.6]: https://github.com/uclahs-cds/package-PipeVal/releases/tag/v2.1.6
126+
[3.0.0]: https://github.com/uclahs-cds/package-PipeVal/compare/v2.1.6...v3.0.0
127+
[4.0.0]: https://github.com/uclahs-cds/package-PipeVal/compare/v4.0.0-rc.2...v4.0.0
128+
[4.0.0-rc.1]: https://github.com/uclahs-cds/package-PipeVal/compare/v3.0.0...v4.0.0-rc.1
129+
[4.0.0-rc.2]: https://github.com/uclahs-cds/package-PipeVal/compare/v4.0.0-rc.1...v4.0.0-rc.2
130+
[5.0.0]: https://github.com/uclahs-cds/package-PipeVal/compare/v5.0.0-rc.3...v5.0.0
131+
[5.0.0-rc.1]: https://github.com/uclahs-cds/package-PipeVal/compare/v4.0.0...v5.0.0-rc.1
132+
[5.0.0-rc.2]: https://github.com/uclahs-cds/package-PipeVal/compare/v5.0.0-rc.1...v5.0.0-rc.2
133+
[5.0.0-rc.3]: https://github.com/uclahs-cds/package-PipeVal/compare/v5.0.0-rc.2...v5.0.0-rc.3
134+
[5.1.0]: https://github.com/uclahs-cds/package-PipeVal/compare/v5.0.0...v5.1.0
135+
[5.2.0]: https://github.com/uclahs-cds/package-PipeVal/compare/v5.1.0...v5.2.0

pipeval/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
'''Inits pipeval module'''
22

3-
__version__ = '5.0.0-rc.3'
3+
__version__ = '5.2.0'

0 commit comments

Comments
 (0)