Skip to content

Commit ae20172

Browse files
EnriqueSoriaEnriqueSoria
committed
chore: Move changelog to its own file
1 parent dac1c4e commit ae20172

File tree

2 files changed

+140
-137
lines changed

2 files changed

+140
-137
lines changed

‎CHANGELOG.md‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# Changelog
2+
3+
## 1.0.3 (November 2023)
4+
5+
- Drop support for Django < 2.2.
6+
- Confirm support for Django 5.0. Thanks @adamchainz!
7+
- Remove urlman from required packages. Thanks @DmytroLitvinov!
8+
- Add an optional Django check to avoid errors by not inheriting from `LifecycleModelMixin` (or `LifecycleModel`)
9+
10+
## 1.0.2 (September 2023)
11+
12+
- Correct package info to note that Django 4.0, 4.1, and 4.2 are supported.
13+
14+
## 1.0.1 (August 2023)
15+
16+
- Initial state gets reset using `transaction.on_commit()`, fixing the `has_changed()` and `initial_value()` methods for on_commit hooks. Thanks @alb3rto269!
17+
18+
19+
## 1.0.0 (May 2022)
20+
21+
- Drops Python 3.6 support
22+
- Adds `priority` hook kwarg to control the order in which hooked methods fire. Thanks @EnriqueSoria!
23+
- Internal cleanup/refactoring. Thanks @EnriqueSoria!
24+
25+
## 0.9.6 (February 2022)
26+
27+
- Adds missing `packaging` to `install_requires`. Thanks @mikedep333!
28+
29+
## 0.9.5 (February 2022)
30+
31+
- Makes the `has_changed`, `changes_to` conditions depend on whether the field in question was included in the SQL update/insert statement by checking
32+
the `update_fields` argument passed to save.
33+
34+
## 0.9.4 (February 2022)
35+
36+
- Adds optional @hook `on_commit` argument for executing hooks when the database transaction is committed. Thanks @amcclosky!
37+
38+
## 0.9.3 (October 2021)
39+
40+
- Correct packge info to note that Django 3.2 is supported.
41+
42+
## 0.9.2 (October 2021)
43+
44+
- Run hooked methods inside transactions, just as signals do. Thanks @amirmotlagh!
45+
46+
## 0.9.1 (March 2021)
47+
48+
- Makes hooks work with OneToOneFields. Thanks @bahmdev!
49+
50+
## 0.9.0 (February 2021)
51+
52+
- Prevents calling a hooked method twice with the same state. Thanks @garyd203!
53+
54+
## 0.8.1 (January 2021)
55+
56+
- Added missing return to `delete()` method override. Thanks @oaosman84!
57+
58+
## 0.8.0 (October 2020)
59+
60+
- Significant performance improvements. Thanks @dralley!
61+
62+
## 0.7.7 (August 2020)
63+
64+
- Fixes issue with `GenericForeignKey`. Thanks @bmbouter!
65+
66+
## 0.7.6 (May 2020)
67+
68+
- Updates to use constants for hook names; updates docs to indicate Python 3.8/Django 3.x support. Thanks @thejoeejoee!
69+
70+
## 0.7.5 (April 2020)
71+
72+
- Adds static typed variables for hook names; thanks @Faisal-Manzer!
73+
- Fixes some typos in docs; thanks @tomdyson and @bmispelon!
74+
75+
## 0.7.1 (January 2020)
76+
77+
- Fixes bug in `utils._get_field_names` that could cause recursion bug in some cases.
78+
79+
## 0.7.0 (December 2019)
80+
81+
- Adds `changes_to` condition - thanks @samitnuk! Also some typo fixes in docs.
82+
83+
## 0.6.1 (November 2019)
84+
85+
- Remove variable type annotation for Python 3.5 compatability.
86+
87+
## 0.6.0 (October 2019)
88+
89+
- Adds `when_any` hook parameter to watch multiple fields for state changes
90+
91+
## 0.5.0 (September 2019)
92+
93+
- Adds `was_not` condition
94+
- Allow watching changes to FK model field values, not just FK references
95+
96+
## 0.4.2 (July 2019)
97+
98+
- Fixes missing README.md issue that broke install.
99+
100+
## 0.4.1 (June 2019)
101+
102+
- Fixes [urlman](https://github.com/andrewgodwin/urlman)-compatability.
103+
104+
## 0.4.0 (May 2019)
105+
106+
- Fixes `initial_value(field_name)` behavior - should return value even if no change. Thanks @adamJLev!
107+
108+
## 0.3.2 (February 2019)
109+
110+
- Fixes bug preventing hooks from firing for custom PKs. Thanks @atugushev!
111+
112+
## 0.3.1 (August 2018)
113+
114+
- Fixes m2m field bug, in which accessing auto-generated reverse field in `before_create` causes exception b/c PK does not exist yet. Thanks @garyd203!
115+
116+
## 0.3.0 (April 2018)
117+
118+
- Resets model's comparison state for hook conditions after `save` called.
119+
120+
## 0.2.4 (April 2018)
121+
122+
- Fixed support for adding multiple `@hook` decorators to same method.
123+
124+
## 0.2.3 (April 2018)
125+
126+
- Removes residual mixin methods from earlier implementation.
127+
128+
## 0.2.2 (April 2018)
129+
130+
- Save method now accepts `skip_hooks`, an optional boolean keyword argument that controls whether hooked methods are called.
131+
132+
## 0.2.1 (April 2018)
133+
134+
- Fixed bug in `_potentially_hooked_methods` that caused unwanted side effects by accessing model instance methods decorated with `@cache_property` or `@property`.
135+
136+
## 0.2.0 (April 2018)
137+
138+
- Added Django 1.8 support. Thanks @jtiai!
139+
- Tox testing added for Python 3.4, 3.5, 3.6 and Django 1.8, 1.11 and 2.0. Thanks @jtiai!

‎README.md‎

Lines changed: 1 addition & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -64,143 +64,7 @@ Instead of overriding `save` and `__init__` in a clunky way that hurts readabili
6464

6565
# Changelog
6666

67-
## 1.0.3 (November 2023)
68-
69-
- Drop support for Django < 2.2.
70-
- Confirm support for Django 5.0. Thanks @adamchainz!
71-
- Remove urlman from required packages. Thanks @DmytroLitvinov!
72-
- Add an optional Django check to avoid errors by not inheriting from `LifecycleModelMixin` (or `LifecycleModel`)
73-
74-
## 1.0.2 (September 2023)
75-
76-
- Correct package info to note that Django 4.0, 4.1, and 4.2 are supported.
77-
78-
## 1.0.1 (August 2023)
79-
80-
- Initial state gets reset using `transaction.on_commit()`, fixing the `has_changed()` and `initial_value()` methods for on_commit hooks. Thanks @alb3rto269!
81-
82-
83-
## 1.0.0 (May 2022)
84-
85-
- Drops Python 3.6 support
86-
- Adds `priority` hook kwarg to control the order in which hooked methods fire. Thanks @EnriqueSoria!
87-
- Internal cleanup/refactoring. Thanks @EnriqueSoria!
88-
89-
## 0.9.6 (February 2022)
90-
91-
- Adds missing `packaging` to `install_requires`. Thanks @mikedep333!
92-
93-
## 0.9.5 (February 2022)
94-
95-
- Makes the `has_changed`, `changes_to` conditions depend on whether the field in question was included in the SQL update/insert statement by checking
96-
the `update_fields` argument passed to save.
97-
98-
## 0.9.4 (February 2022)
99-
100-
- Adds optional @hook `on_commit` argument for executing hooks when the database transaction is committed. Thanks @amcclosky!
101-
102-
## 0.9.3 (October 2021)
103-
104-
- Correct packge info to note that Django 3.2 is supported.
105-
106-
## 0.9.2 (October 2021)
107-
108-
- Run hooked methods inside transactions, just as signals do. Thanks @amirmotlagh!
109-
110-
## 0.9.1 (March 2021)
111-
112-
- Makes hooks work with OneToOneFields. Thanks @bahmdev!
113-
114-
## 0.9.0 (February 2021)
115-
116-
- Prevents calling a hooked method twice with the same state. Thanks @garyd203!
117-
118-
## 0.8.1 (January 2021)
119-
120-
- Added missing return to `delete()` method override. Thanks @oaosman84!
121-
122-
## 0.8.0 (October 2020)
123-
124-
- Significant performance improvements. Thanks @dralley!
125-
126-
## 0.7.7 (August 2020)
127-
128-
- Fixes issue with `GenericForeignKey`. Thanks @bmbouter!
129-
130-
## 0.7.6 (May 2020)
131-
132-
- Updates to use constants for hook names; updates docs to indicate Python 3.8/Django 3.x support. Thanks @thejoeejoee!
133-
134-
## 0.7.5 (April 2020)
135-
136-
- Adds static typed variables for hook names; thanks @Faisal-Manzer!
137-
- Fixes some typos in docs; thanks @tomdyson and @bmispelon!
138-
139-
## 0.7.1 (January 2020)
140-
141-
- Fixes bug in `utils._get_field_names` that could cause recursion bug in some cases.
142-
143-
## 0.7.0 (December 2019)
144-
145-
- Adds `changes_to` condition - thanks @samitnuk! Also some typo fixes in docs.
146-
147-
## 0.6.1 (November 2019)
148-
149-
- Remove variable type annotation for Python 3.5 compatability.
150-
151-
## 0.6.0 (October 2019)
152-
153-
- Adds `when_any` hook parameter to watch multiple fields for state changes
154-
155-
## 0.5.0 (September 2019)
156-
157-
- Adds `was_not` condition
158-
- Allow watching changes to FK model field values, not just FK references
159-
160-
## 0.4.2 (July 2019)
161-
162-
- Fixes missing README.md issue that broke install.
163-
164-
## 0.4.1 (June 2019)
165-
166-
- Fixes [urlman](https://github.com/andrewgodwin/urlman)-compatability.
167-
168-
## 0.4.0 (May 2019)
169-
170-
- Fixes `initial_value(field_name)` behavior - should return value even if no change. Thanks @adamJLev!
171-
172-
## 0.3.2 (February 2019)
173-
174-
- Fixes bug preventing hooks from firing for custom PKs. Thanks @atugushev!
175-
176-
## 0.3.1 (August 2018)
177-
178-
- Fixes m2m field bug, in which accessing auto-generated reverse field in `before_create` causes exception b/c PK does not exist yet. Thanks @garyd203!
179-
180-
## 0.3.0 (April 2018)
181-
182-
- Resets model's comparison state for hook conditions after `save` called.
183-
184-
## 0.2.4 (April 2018)
185-
186-
- Fixed support for adding multiple `@hook` decorators to same method.
187-
188-
## 0.2.3 (April 2018)
189-
190-
- Removes residual mixin methods from earlier implementation.
191-
192-
## 0.2.2 (April 2018)
193-
194-
- Save method now accepts `skip_hooks`, an optional boolean keyword argument that controls whether hooked methods are called.
195-
196-
## 0.2.1 (April 2018)
197-
198-
- Fixed bug in `_potentially_hooked_methods` that caused unwanted side effects by accessing model instance methods decorated with `@cache_property` or `@property`.
199-
200-
## 0.2.0 (April 2018)
201-
202-
- Added Django 1.8 support. Thanks @jtiai!
203-
- Tox testing added for Python 3.4, 3.5, 3.6 and Django 1.8, 1.11 and 2.0. Thanks @jtiai!
67+
See [Changelog](CHANGELOG.md)
20468

20569
# Testing
20670

0 commit comments

Comments
 (0)