This instance will be upgraded to Heptapod 0.19.0rc2 on 2021-01-18 at 11:00 UTC+1 (a few minutes of downtime)

Commit aafa0154 authored by Ashwin Vishnu's avatar Ashwin Vishnu

Keep a changelog + towncrier config

parent c1b4b2dd08ae
Pipeline #11860 passed with stage
in 11 minutes and 48 seconds
Changes
=======
0.3.3 (2020-10-15)
------------------
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.0.0/>`__, and this project
adheres to `Semantic
Versioning <https://semver.org/spec/v2.0.0.html>`__.
.. Type of changes
.. ---------------
.. Added Added for new features.
.. Changed Changed for changes in existing functionality.
.. Deprecated Deprecated for soon-to-be removed features.
.. Removed Removed for now removed features.
.. Fixed Fixed for any bug fixes.
.. Security Security in case of vulnerabilities.
Unreleased_
-----------
.. towncrier release notes start
.. _Unreleased: https://foss.heptapod.net/fluiddyn/fluidsim/-/compare/0.3.3...branch%2Fdefault
0.3.3_ (2020-10-15)
-------------------
- Bugfixes and optimizations (in particular for ns3d solvers)
- Forcing WATU Coriolis and Milestone for ns3d.strat
......@@ -8,20 +33,20 @@
- Timestepping using phase-shifting for dealiasing
- Improve regularity of saving for some outputs
0.3.2 (2019-11-14)
------------------
0.3.2_ (2019-11-14)
-------------------
- Bug fixes and Transonic 0.4 compatibility
0.3.1 (2019-03-07)
------------------
0.3.1_ (2019-03-07)
-------------------
- Windows compatibility
- Only Python code (stop using Cython)
- Improvements ns2d.strat
0.3.0 (2019-01-31)
------------------
0.3.0_ (2019-01-31)
-------------------
- Drop support for Python 2.7!
- Accelerated by Transonic & Pythran (also time stepping)
......@@ -31,19 +56,19 @@
- Fix several bugs :-)
- New function load_for_restart
0.2.2 (2018-07-01)
------------------
0.2.2_ (2018-07-01)
-------------------
- Let fluidfft decides which FFT class to use (dependency fluidfft >= 0.2.4)
0.2.1 (2018-05-24)
------------------
0.2.1_ (2018-05-24)
-------------------
- IPython magic commands (by Ashwin Vishnu).
- Bugfix divergence-free flow and time_stepping in ns3d solvers.
0.2.0 (2018-05-04)
------------------
0.2.0_ (2018-05-04)
-------------------
- Many bugfixes and nicer code (using the Python code formatter Black).
- Faster ns3d solver.
......@@ -103,3 +128,11 @@ Merge with geofluidsim (Ashwin Vishnu Mohanan repository)
- Split the package fluiddyn between one base package and specialized
packages.
.. _0.3.3: https://foss.heptapod.net/fluiddyn/fluidsim/-/compare/0.3.2...0.3.3
.. _0.3.2: https://foss.heptapod.net/fluiddyn/fluidsim/-/compare/0.3.1...0.3.2
.. _0.3.1: https://foss.heptapod.net/fluiddyn/fluidsim/-/compare/0.3.0...0.3.1
.. _0.3.0: https://foss.heptapod.net/fluiddyn/fluidsim/-/compare/0.2.2...0.3.0
.. _0.2.2: https://foss.heptapod.net/fluiddyn/fluidsim/-/compare/0.2.1...0.2.2
.. _0.2.1: https://foss.heptapod.net/fluiddyn/fluidsim/-/compare/0.2.0...0.2.1
.. _0.2.0: https://foss.heptapod.net/fluiddyn/fluidsim/-/compare/0.1.1...0.2.0
Changes
=======
.. include:: ../CHANGES.rst
:orphan:
Creating news fragments
=======================
This directory contains "news fragments" which are short files that contain a
small **ReST**-formatted text that will be added to the next what's new page.
Read more about it here_.
.. _here: https://fluiddyn.readthedocs.io/en/latest/newsfragments/README.html
{% set package = versiondata.name|lower %}
.. _Unreleased: https://foss.heptapod.net/fluiddyn/{{ package }}/-/compare/{{ versiondata.version }}...branch%2Fdefault
{% set underline = underlines[0] -%}
{% set version_heading = "{}_ ({})".format(versiondata.version, versiondata.date) -%}
{{ version_heading }}
{{ underline * version_heading|length }}
{% set underline = underlines[1] -%}
{% for section, _ in sections.items() -%}{# section loop #}
{% if sections[section] -%}{# section #}
{% for category, val in definitions.items() if category in sections[section] %}{# category loop #}
{{ definitions[category]['name'] }}
{{ underline * definitions[category]['name']|length }}
{% if definitions[category]['showcontent'] -%}{# category #}
{% for text, values in sections[section][category].items() %}{# fragments loop #}
* {{values|join(', ') }} : {{ text }}
{% endfor %}{# fragments loop #}
{% else %}{# fragments #}
* {{ sections[section][category]['']|join(', ') }}
{% endif -%}{# fragments #}
{% if sections[section][category]|length == 0 %}{# category null #}
No significant changes.
{% else -%}{# category null #}
{% endif -%}{# category null #}
{% endfor -%}{# category loop #}
{% else -%}{# section #}
No significant changes.
{% endif %}{# section null #}
{% endfor %}{# section loop #}
.. _{{ versiondata.version }}: https://foss.heptapod.net/fluiddyn/{{ package }}/-/compare/x.y.z...{{ versiondata.version }}
.. FIXME: replace x.y.z with previous version in the above line and remove old `_Unreleased` link below
......@@ -3,3 +3,45 @@
# the PEP 517 interface.
requires = ["setuptools>=49.5.0", "setuptools_scm", "wheel", "numpy", "transonic>=0.4.3"]
build-backend = "setuptools.build_meta"
[tool.towncrier]
package = "fluidsim"
single_file = true # if false, filename is formatted like `title_format`.
filename = "CHANGES.rst"
directory = "doc/newsfragments"
template = "doc/newsfragments/template.rst.j2"
title_format = false # if false, template includes title
issue_format = "`!{issue} <https://foss.heptapod.net/fluiddyn/fluidsim/-/merge_requests/{issue}>`__"
underline = "-~"
# wrap = true # Wrap text to 79 characters
all_bullets = true # make all fragments bullet points
[[tool.towncrier.type]]
directory = "added"
name = "Added"
showcontent = true
[[tool.towncrier.type]]
directory = "changed"
name = "Changed"
showcontent = true
[[tool.towncrier.type]]
directory = "deprecated"
name = "Deprecated"
showcontent = true
[[tool.towncrier.type]]
directory = "removed"
name = "Removed"
showcontent = true
[[tool.towncrier.type]]
directory = "fixed"
name = "Fixed"
showcontent = true
[[tool.towncrier.type]]
directory = "security"
name = "Security"
showcontent = true
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment