Skip to content

Commit 338860c

Browse files
committed
Add release notes
1 parent c6e96d6 commit 338860c

File tree

1 file changed

+82
-0
lines changed

1 file changed

+82
-0
lines changed

docs/release-notes.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# ShinyCMS Documentation
2+
3+
## Release Notes
4+
5+
This file contains information about changes (particularly breaking changes) between releases - with the most recent release first.
6+
7+
8+
### 2020-11-09 - v20.11 - November 2020: The 'tricky second album' release
9+
10+
* Plugin versions:
11+
* There have been code changes in every plugin since 20.10 release, so their version numbers have all been bumped to 20.11 too
12+
13+
* Updates and changes since 20.10:
14+
* General:
15+
* Ruby version: 2.7.1 -> 2.7.2
16+
* Rubocop:
17+
* Added some enforcement of preferred whitespace rules
18+
* Various updates to config for new versions with new cops
19+
* Configuration:
20+
* Added Setting.get_int method to get integer values from setting strings
21+
* Added Setting.true? method to get boolean results from 'true'/'false' setting strings
22+
* Started moving config that isn't secrets/credentials from ENV vars to Setting model
23+
* Deprecated ENV vars:
24+
* TODO!!
25+
* Supporting code (Helpers, Concerns, etc):
26+
* Added helper methods to abstract anywhere a main site view called a model
27+
* Renamed Plugin model to ShinyPlugin
28+
* Renamed FeatureFlagsHelper to ShinyFeatureFlagHelper
29+
* Renamed PagingHelper to ShinyPagingHelper
30+
* Renamed ElementsHelper to ShinyElementHelper
31+
* Refactored AkismetHelper to allow checking generic form submissions as well as comments
32+
* Pulled methods from ShinyMainSiteHelper into their own files:
33+
* Added ShinyConsentHelper for retrieving ConsentVersion details
34+
* Added ShinySettingsHelper for retrieving config settings
35+
* Comments/Discussions:
36+
* Changes to names of settings and code relating to who can post a comment (anon/etc)
37+
* Moved comment author details into a separate model
38+
* Mailer templates:
39+
* Added fancier MJML templates for discussion, user, and email recipient mailers
40+
41+
* New since 20.10:
42+
* General:
43+
* Added .env.test file, replacing some setup code in spec/spec_helper.rb
44+
* Gems:
45+
* acts_as_paranoid (add soft delete to models)
46+
* kaminari_route_prefix (fix kaminari pagination with Rails Engines routes)
47+
* sidekiq-status (display additional details in sidekiq web dashboard)
48+
* Supporting code (Helpers, Concerns, etc):
49+
* Added ShinyPaging concern, to set up kaminari pagination on a model
50+
* Added ShinySoftDelete concern, to set up acts_as_paranoid on a model
51+
* Added ShinyClassName concern, for easy access to an i18n-translated name for a type of site content from its model (e.g. 'blog post')
52+
* Added ShinyTemplateElement, to group common behaviour of template elements
53+
* Added ShinyPostAtomFeed and ShinyPostAtomFeedEntry, for constructing atom feeds
54+
* Admin Area:
55+
* Added pagination to index/list pages for most plugins/features
56+
* Added search to index/list pages for most plugins/features
57+
* Added new page for viewing and managing non-user-account Email Recipients
58+
* Added new 'Email' menu section, containing above page & mailer previews
59+
* Added menu item for Sidekiq web dashboard
60+
* Plugins:
61+
* ShinyBlog & ShinyNews
62+
* Added atom feed generation (can be written to local disk or AWS S3)
63+
* Added pagination on main site
64+
* ShinyForms
65+
* Added reCAPTCHA and Akismet checking for form submissions
66+
* ShinyNewsletters
67+
* Added 'drag to sort' in admin area, for:
68+
* Elements on Newsletter Edition and Newsletter Template edit pages
69+
* ShinyPages
70+
* Added 'drag to sort' in admin area, for:
71+
* Elements on Page and Page Template edit pages
72+
* Pages and Sections on main Page/Section list page (/admin/pages)
73+
74+
* Fixes since 20.10:
75+
* Fixed names of user mailer methods in various places (by adding '_instructions')
76+
* Added missing edit-capability templates in a few plugins, that were causing admins to lose capabilities when edited and saved via the web UI
77+
78+
79+
### 2020-10-01 - v20.10 - October 2020: The 'First Birthday' release
80+
81+
* This is the first release, tagged v20.10 on GitHub:
82+
* https://github.com/denny/ShinyCMS-ruby/releases/tag/v20.10

0 commit comments

Comments
 (0)