Skip to content

Commit

Permalink
update changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
ianspektor committed Aug 23, 2023
1 parent 26c1542 commit e42467c
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 13 deletions.
21 changes: 11 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# Changelog
# Release notes

## HEAD (might become 0.1.3)
## Latest changes (unreleased)

### Features

### Fixes

## 0.1.3

This is the first operational version of Temporian for users. The list whole and
detailed list of features is too long to be listed. The top features are:
detailed list of features is too long to be listed. The main features are:

### Feature
### Features

- Pypi release.
- PyPI release.
- 72 operators.
- Execution in eager, compiled mode, and graph mode.
- IO Support for Pandas, CSV, Numpy and TensorFlow datasets.
- Static and interactive plotting.
- Documentation (3 minutes intro, user guide and API references).
- 5 tutorials.

### Fix

- Proper error message when using distributed training on more than 2^31
(i.e., ~2B) examples while compiling YDF with 32-bits example index.
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ nav:
- Recipes: recipes/
- Tutorials: tutorials/
- API Reference: reference/ # generated by gen-files + literate-nav
- Changelog: CHANGELOG.md
- Release notes: CHANGELOG.md

# Plugins
plugins:
Expand Down
6 changes: 4 additions & 2 deletions tools/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ To create a new release, follow these steps:

1. Update the version number in `pyproject.toml` and `temporian/__init__.py` to the new version number (e.g. `1.3.2`), commit, and open and merge a PR to `main`, titled `Release v1.3.2` in this case.

2. Create a new [GitHub release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release) with the new version's name prepended with `v`, e.g. `v1.3.2`.
2. Edit the [changelog](../CHANGELOG.md) by moving the latest changes to the new version's section and clearing the latest changes one.

3. Tag that commit as the new stable version with `git tag stable -f`, and push it with `git push origin stable -f`.
3. Create a new [GitHub release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release) with the new version's name prepended with `v`, e.g. `v1.3.2`.

4. Tag that commit as the new stable version with `git tag stable -f`, and push it with `git push origin stable -f`.
- This gives us a way to easily find the latest stable version of the code in the GitHub tree (used for example by the tutorial notebooks to not open an unreleased version of the notebooks).

0 comments on commit e42467c

Please sign in to comment.