releasenotes.md 6.61 KB
Newer Older
mattwire's avatar
mattwire committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
## Information

Releases use the following numbering system:
**{major}.{minor}.{incremental}**

* major: Major refactoring or rewrite - make sure you read and test very carefully!
* minor: Breaking change in some circumstances, or a new feature. Read carefully and make sure you understand the impact of the change.
* incremental: A "safe" change / improvement. Should *always* be safe to upgrade.

* **[BC]**: Items marked with [BC] indicate a breaking change that will require updates to your code if you are using that code in your extension.

## Release 3.4.3

* Fix [#9](https://lab.civicrm.org/extensions/ukgiftaid/-/issues/4) Fix contributions marked not-eligible when line items missing

mattwire's avatar
mattwire committed
16
17
18
19
20
21
## Release 3.4.2

* Fix [#4](https://lab.civicrm.org/extensions/ukgiftaid/-/issues/4) - Individual donation marked as "NO" from backend, gets included in batch.
* Remove unused lineitems display from add/remove to batch.
* Add 'View' action to contributions on add/remove batch list.

mattwire's avatar
mattwire committed
22
## Release 3.4.1
mattwire's avatar
mattwire committed
23
24

* Add GiftAid.Updatedeclarations API
mattwire's avatar
mattwire committed
25
26
27
* Use title that user entered when adding to batch
* Disable logging when fixing declarations/contributions via API
* Fix crash with disable then enable extension
mattwire's avatar
mattwire committed
28

mattwire's avatar
mattwire committed
29
30
## Release 3.4
This release adds unit tests, fixes multiple issues, improves documentation and adds a field "Given Date" to the declaration.
Rich's avatar
Rich committed
31

mattwire's avatar
mattwire committed
32
* Update empty address when updating declaration
Rich's avatar
Rich committed
33
34
35
36
* Add date declaration was given, as well as the start date. (Currently
  defaults to the same.)
* Fix bug when recording a not-eligible declaration and a future
  is-eligible declaration exists.
mattwire's avatar
mattwire committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
* Fix #3 - generate correct link for gift aid declaration tab
* Don't create 'Yes, in past 4 years' optionvalue for contributions on install....
* Fix issues with Contribution customfield metadata in installer
* Trigger postInstall hook which is required on install to set revision so upgrader steps are not run
* Followup re gitlab issue #2 - fix problem with shared field name
* Fix license link
* Update documentation
* Fix gitlab issue #2: cannot reinstall after uninstall
* Add eligibility flowchart (graphviz .dot format source)
* Don't worry about calculating gift aid fields twice
* Add unit tests
* fix issue #24 setDeclaration called with missing eligible_for_gift_aid param
* Identify eligibility by line items not contribution financial type. Fixes issue #19
* Fix install wrongly setting table-level default batch; add first two tests
* Improve code readability and avoid duplicated method calls
* Simplify fetching list of entity_ids
Rich's avatar
Rich committed
53

54
55
56
57
58
## Release 3.3.11

* Use "Primary" address instead of "Home" address for declarations.
* Remove code to handle multiple charities - it is untested and probably doesn't work anymore and adds complexity to the code.

mattwire's avatar
mattwire committed
59
60
61
62
63
## Release 3.3.10

* Only display eligible but no declaration message if logged in and has access to civicontribute.
* Use session to track giftaid selections on form so it works with confirmation page.

mattwire's avatar
mattwire committed
64
65
66
67
## Release 3.3.9

* Fix crash on contribution thankyou page when a new contact is created.

68
69
70
71
## Release 3.3.8

* Refactor GiftAid report to fix multiple issues and show batches with multiple financial types.

mattwire's avatar
mattwire committed
72
73
74
75
## Release 3.3.7

* Allow editing address on the declaration.

mattwire's avatar
mattwire committed
76
77
78
79
## Release 3.3.6

* Rework "Remove from Batch" to improve performance and ensure that what is shown on the screen is what is added to the batch.
* Rework "Add to Batch" task to improve performance and ensure that what is shown on the screen is what is added to the batch.
homotechsual's avatar
homotechsual committed
80
* Update GiftAid.updateeligiblecontributions API and [document](api.md).
mattwire's avatar
mattwire committed
81

mattwire's avatar
mattwire committed
82
83
84
## Release 3.3.5

* Update and refactor how we create/update declarations.
homotechsual's avatar
homotechsual committed
85
* Added [documentation for declarations](declaration.md) to explain how the declarations are created/updated and what the fields mean.
mattwire's avatar
mattwire committed
86

87
88
89
## Release 3.3.4

* Fix issues with setting "Eligible for gift aid" on contributions.
homotechsual's avatar
homotechsual committed
90
* Added [documentation for contributions](contributions.md) to explain how the gift aid fields on contributions work.
91

mattwire's avatar
mattwire committed
92
93
94
95
96
97
98
99
100
101
## Release 3.3.3

* Include first donation in the batch
* Due to the timestamp on the declaration is created after the contribution hence the first donation doesn't gets included in batch. Set the timestamp as the date rather than time.
* Clear batch_name if we created a new contribution in a recur series (it's copied across by default by Contribution.repeattransaction).
* Check and set label for 'Eligible amount' field on contribution.
* Always make sure current declaration is set if we have one - fixes issue with overwriting declaration with 'No'.
* Fix [#5](https://github.com/mattwire/uk.co.compucorp.civicrm.giftaid/issues/5) Donations included in batch although financial types disabled in settings.
* Trigger create of new gift aid declaration from contribution form if required.

mattwire's avatar
mattwire committed
102
103
104
105
106
107
108
## Release 3.3.2

* Handle transitions between the 3 declaration states without losing information - create a new declaration when state is changed.
* Refactor creating/updating declaration when contribution is created/updated.
* Properly escape SQL parameters when updating gift aid declaration.
* Extract code to check if charity column exists.

109
110
111
112
## Release 3.3.1

* Major performance improvement to "Add to Batch".

mattwire's avatar
mattwire committed
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
## Release 3.3
**In this release we update profiles to use the declaration eligibility field instead of the contribution.
This allows us to create a new declaration (as it will be the user filling in a profile via contribution page etc.)
 and means we don't create a declaration when time a contribution is created / imported with the "eligible" flag set to Yes.**

**IMPORTANT: Make sure you run the extension upgrades (3104).**

* Fix status message on AddToBatch.
* Fix crash on enable/disable extension.
* Fix creating declarations every time we update a contribution.
* Refactor insert/updateDeclaration.
* Refactor loading of optiongroups/values - we load them in the upgrader in PHP meaning that we always ensure they are up to date with the latest extension.
* Add documentation in mkdocs format (just extracted from README for now).
* Make sure we properly handle creating/ending and creating a declaration again (via eg. contribution page).
* Allow for both declaration eligibility and individual contribution eligibility to be different on same profile (add both fields).
* Fix PHP notice in GiftAid report.
* Match on OptionValue value when running upgrader as name is not always consistent.

## Release 3.2
mattwire's avatar
mattwire committed
132
* Be stricter checking eligible_for_gift_aid variable type
mattwire's avatar
mattwire committed
133
134
135
136
137
138
139
140
141
* Fix issues with entity definition and regenerate
* Fix PHP notice
* Refactor addtobatch for performance, refactor upgrader for reliability
* Add API to update the eligible_for_gift_aid flag on contributions

## Release 3.1
* Be stricter checking eligible_for_gift_aid variable type