Skip to content

Clear release notes #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 25, 2023
Merged

Clear release notes #123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 10 additions & 26 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,28 @@

## Summary

This version focus on some bug fixes and final polishing of v0.5.x.
<!-- Here goes a general summary of what this release is about -->

## Upgrading

### Cookiecutter template

- If your replay file contains a `_extensions` key, you should remove it, as you most likely want to use the extensions declared by the repo-config cookiecutter template you are upgrading to, otherwise you could get errors about missing extensions.

- If your replay file contains a long `Introduction` key, you can replace it with an empty string (`""`), it doesn't need to have any particular content and it increases the size and noise in the replay file.

## New Features
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

### Cookiecutter template

- Generated project's dependencies were bumped.

- Move `TODO`s so they are in their own line.

This makes it easier to upgrade projects to new templates, as removing whole lines is easier than having to edit them.
<!-- Here upgrade steps for cookiecutter specifically -->

- Clean up `_extensions` from the generated replay file.

It is not needed in the generated project, we always want to use the ones from the repo-config template.

This should ease upgrading projects, making it less likely to have errors about missing extensions.

- Clean up the `Introduction` variable from the generated replay file.

This is just a hack to be able to show a help about the template variables, keeping that text only increases the size and noise in the replay file.
## New Features

- Add a `\n` to the end of the replay file.
<!-- Here goes the main new features and examples or instructions on how to use them -->

This is just to be nice to most editors and text files conventions, that likes it more if there is a `\n` at the end of the file.
### Cookiecutter template

- API: The common-api documentation now is cross-linked.
<!-- Here new features for cookiecutter specifically -->

## Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

### Cookiecutter template

- Properly label `conftest.py` files.
<!-- Here bug fixes for cookiecutter specifically -->