Skip to content

Commit

Permalink
docs: update changelog for 1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
sinaatalay committed Mar 27, 2024
1 parent b05d889 commit b3e08e0
Showing 1 changed file with 45 additions and 28 deletions.
73 changes: 45 additions & 28 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,34 @@ All notable changes to this project will be documented in this file.

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

[Click here to see the unreleased changes.](https://github.com/sinaatalay/rendercv/compare/v1.4...HEAD)
[Click here to see the unreleased changes.](https://github.com/sinaatalay/rendercv/compare/v1.5...HEAD)

<!--
### Fixed
### Added
### Changed
### Fixed
### Removed
### Added
-->

## [1.5] = 2024-03-27

### Added
- Users can now make bold or italic texts normal with Markdown syntax.

### Changed
- The `moderncv` theme doesn't italicize any text by default now.

### Fixed
- The `moderncv` theme's PDF title issue has been fixed.
- The ordering of the data models' keys in JSON Schema has been fixed.
- The unhandled exception when a custom theme's `__init__.py` file is invalid has been fixed.
- The `sb2nov` themes' `PublicationEntry` without `journal` and `doi` fields is now rendered correctly.
- The `sb2nov` themes' `OneLineEntry`'s colon issue has been fixed.

## [1.4] - 2024-03-10

### Added
- A new entry type is added: `BulletEntry`
- A new entry type has been added: `BulletEntry`

### Changed
- `OneLineEntry`'s `name` field has been changed to `label`. This was required to generalize the entry validations.
Expand All @@ -30,28 +45,29 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## [1.3] - 2024-03-09

### Fixed
- The `journal` is now displayed in the `PublicationEntry` of the `sb2nov` theme.

### Added
- CLI documentation has been added to the user guide.

### Changed
- Future dates are now allowed.
- Authors' first names are no longer abbreviated in `PublicationEntry`.
- Markdown is now supported in the `authors` field of `PublicationEntry`.
- `doi` field is now optional for `PublicationEntry`.

### Added
- CLI documentation has been added to the user guide.
### Fixed
- The `journal` is now displayed in the `PublicationEntry` of the `sb2nov` theme.


## [1.2] - 2024-02-27

### Fixed

- Fixed Markdown `TextEntry`, where all the paragraphs were concatenated into a single paragraph.
- Fixed Markdown `OneLineEntry`, where all the one-line entries were concatenated into a single line.
- Fixed the `classic` theme's `PublicationEntry`, where blank parentheses were rendered when the `journal` field was not provided.
- Fixed a bug where an email with special characters caused a LaTeX error.
- Fixed Unicode error when `rendercv new` is called with a name with special characters.
- Markdown `TextEntry`, where all the paragraphs were concatenated into a single paragraph, has been fixed.
- Markdown `OneLineEntry`, where all the one-line entries were concatenated into a single line, has been fixed.
- The `classic` theme's `PublicationEntry`, where blank parentheses were rendered when the `journal` field was not provided, has been fixed.
- A bug, where an email with special characters caused a LaTeX error, has been fixed.
- Unicode error, when `rendercv new` is called with a name with special characters, has been fixed.


## [1.1] - 2024-02-25
Expand All @@ -65,28 +81,28 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

### Changed

- The data model is changed to be more flexible. All the sections are now under the `sections` field. All the keys are arbitrary and rendered as section titles. The entry types can be any of the six built-in entry types, and they will be detected by RenderCV for each section.
- The data model has been changed to be more flexible. All the sections are now under the `sections` field. All the keys are arbitrary and rendered as section titles. The entry types can be any of the six built-in entry types, and they will be detected by RenderCV for each section.
- The templating system has been changed completely.
- The command-line interface (CLI) is improved.
- The validation error messages are improved.
- The command-line interface (CLI) has been improved.
- The validation error messages have been improved.
- TinyTeX has been moved to [another repository](https://github.com/sinaatalay/tinytex-release), and it is being pulled as a Git submodule. It is still pushed to PyPI, but it's not a part of the repository anymore.
- Tests are improved, and it uses `pytest` instead of `unittest`.
- Tests have been improved, and it uses `pytest` instead of `unittest`.
- The documentation has been rewritten.
- The reference has been rewritten.
- The build system has been changed from `setuptools` to `hatchling`.

## [0.10] - 2023-11-29

### Fixed
- Author highlighting issue is fixed in PublicationEntry.
- Author highlighting issue has been fixed in `PublicationEntry`.

## [0.9] - 2023-11-29

### Added
- Page numbering is added.
- Text alignment options are added (left-aligned or justified).
- Header options are added (margins and header font size).
- `university_projects` field is added.
- Page numbering has been added.
- Text alignment options have been added (left-aligned or justified).
- Header options have been added (margins and header font size).
- `university_projects` field has been added.

## [0.8] - 2023-11-17

Expand All @@ -96,15 +112,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
## [0.7] - 2023-11-03

### Changed
- The date type is improved. It supports `YYYY-MM-DD`, `YYYY-MM`, and `YYYY` formats now.
- The date type has been improved. It supports `YYYY-MM-DD`, `YYYY-MM`, and `YYYY` formats now.

### Fixed
- Custom sections' error messages fixed.
- Custom sections' error messages have been fixed.

## [0.6] - 2023-10-28

### Added
- New fields are added: `experience`, `projects`, `awards`, `interests`, and `programming_skills`.
- New fields have been added: `experience`, `projects`, `awards`, `interests`, and `programming_skills`.

### Fixed
- DOI validation bug has been fixed by [@LabAsim](https://github.com/LabAsim) in [#3](https://github.com/sinaatalay/rendercv/pull/3)/
Expand All @@ -131,19 +147,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

### Fixed

- Fixed colors of CLI output.
- Fixed encoding problem.
- The colors of CLI output have been fixed.
- Encoding problems have been fixed.

## [0.2] - 2023-10-17

### Fixed

- Fixed MacOS compatibility issues.
- MacOS compatibility issues have been fixed.

## [0.1] - 2023-10-15

The first release of RenderCV.

[1.5]: https://github.com/sinaatalay/rendercv/releases/tag/v1.5
[1.4]: https://github.com/sinaatalay/rendercv/releases/tag/v1.4
[1.3]: https://github.com/sinaatalay/rendercv/releases/tag/v1.3
[1.2]: https://github.com/sinaatalay/rendercv/releases/tag/v1.2
Expand Down

0 comments on commit b3e08e0

Please sign in to comment.