UNPKG

14.2 kBMarkdownView Raw
1# Changelog
2All notable changes to this project will be documented in this file.
3
4The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
7## Unreleased
8### Added
9### Changed
10### Removed
11### Fixed
12
13## [3.8.0] - 2021-04-20
14### Changed
15- `templates/__common__/config/tasks/graphics-meta.js` - Adds a graphic note to the manifest file. Also now logs a warning to the terminal if you don't update the tags in the project config.
16- ` templates/graphic/app/index.html`,
17`templates/graphic/app/static.html`,
18` templates/graphic/app/templates/base.html` - Adds all the proper template attributes to surface notes to the parsing task
19` templates/graphic/graphics-meta.md` - Documents the new key
20
21## [3.7.0] - 2021-03-16
22### Changed
23- `templates/graphic/project.config.js` - Adds new key for adding customization to the parsing step. For now the only one there is one to ignore Apple News for specified files. Adds some placeholder tags to tag our graphics also. (Tags will be included in the graphic metadata.)
24- `templates/__common__/_package.json` - Adds puppeteer and a new `npm run parse` step. Add `npm run parse` to `npm run build` so the parse step runs automatically on deploy.
25- `templates/graphic/README.md` - Adds default Chrome install path, required in the parse step.
26- `templates/graphic/app/templates/base.html` - New meta tags on graphics to be used internally.
27- `templates/graphic/app/index.html`, `templates/graphic/app/static.html` - Add variables to set for graphic metadata, plus data attributes that allow the parser to pull metadata from existing HTML as a fallback.
28
29### Added
30- ` templates/__common__/_.npmrc`- This tells puppeteer to skip downloading chrome each time we create a new project. Saves us some storage on our machines.
31- `templates/__common__/config/scripts/parse.js ` - Task runner that spins up a local server and kicks off the graphics-meta.js step.
32- `templates/__common__/config/tasks/graphics-meta.js `- The base for this whole process. At a high level, this will step through the whole project /dist folder and extract all the relevant metadata info we specify. This is also where we capture screenshots of graphics.
33
34How we generate graphic metadata is also documented in `templates/graphic/graphics-meta.md`.
35
36## [3.6.0] - 2021-01-21
37### Changed
38- `templates/feature/app/templates/includes/ldjson.html` - change some of our attributes in our structured data schema
39
40## [3.5.0] - 2021-01-12
41### Changed
42- `templates/__common__/utils/deployment/update-log-sheet.js` - change ID of the Google sheet to write our projects to
43
44## [3.4.0] - 2020-12-22
45### Changed
46- `package.json` - bump `np` to v7.0.0
47- `templates/feature/app/scripts/utils/ad-loader.js` - set correct ad tags for roofline and footer ads
48- `templates/feature/app/styles/main-queso.scss`, `templates/feature/app/styles/main.scss` - add chart and graphic CSS by default
49- `templates/feature/app/templates/macros/processors-queso.html`, `templates/feature/app/templates/macros/processors.html` - add option to ad to set it as a roofline or footer ad
50- `templates/feature/app/index.html`, `templates/feature/app/index-queso.html` - add footer option to ad to set ad tag
51
52## [3.3.0] - 2020-11-19
53### Changed
54- `templates/graphic/project.config.js`, `templates/feature/project.config.js` - comment the slug and folder variables (folder variable should be changed when the URL slug is changed)
55- `templates/feature/app/index-queso.html` - change `{{ context.title }}` to `{{ context.headline }}`, add HTML to include publish and update dates
56- `templates/feature/app/index.html`, `templates/feature/project.config.js`, `templates/graphic/app/index.html`, `templates/graphic/app/static.html` - change `{{ context.title }}` to `{{ context.headline }}`
57- `templates/feature/app/templates/components/simple-masthead.html`,
58`templates/feature/app/templates/includes/logo.html` - change 10th anniversary logo back to original TT logo
59- `templates/__common__/app/styles/_typography-queso.scss` - add t-subheader styling
60
61### Added
62- `templates/__common__/app/templates/macros/prose-queso.html`, `templates/feature/app/templates/macros/processors-queso.html` - added prose and processors with queso styling
63
64### Fixed
65- `templates/feature/app/index-queso.html`, `templates/feature/app/index.html` - add widont to headline
66
67## [3.2.0] - 2020-09-15
68### Changed
69- `templates/__common__/config/tasks/nunjucks.js` - added getAuthor() and getAuthorLink() to extract author name and author link for structured data schema
70- `templates/feature/app/templates/includes/ldjson.html` - add new structured data attributes
71
72## [3.1.0] - 2020-09-02
73### Added
74- `templates/feature/app/styles/components/_navbar.scss` - added masthead title to the nav bar component in the `index-queso.html` template
75- `templates/feature/app/templates/components/navbar.html` - added additional styling for the masthead title
76
77### Fixed
78- `config/tasks/serve.js` - Adds an extra reload to refresh the page. When you first run npm run start there's a blip of no CSS while the CSS cleanup step runs. This will refresh again after that's finished so that console error referring to that missing CSS clears.
79- `config/tasks/unused-css.js` - Generalizes the gobbing pattern to capture more types of script files and in any folder. Previously CSS classes referenced in JS files weren't making it to the extra-minified CSS file, which is set up to only include classes used in the project.
80
81## [3.0.0] - 2020-08-25
82### Changed
83- `templates/feature/project.config.js` - change destination s3 bucket on deploy
84
85### Fixed
86- `package-lock.json` - bump version of `np` package to resolve security vulnerability
87
88## [2.8.1] - 2020-07-20
89### Fixed
90- `package-lock.json` - bump lodash from 4.17.15 to 4.17.19
91
92## [2.8.0] - 2020-07-20
93### Added
94- `/feature/app/index-queso.html` - Starter template for queso CSS framework
95- `/feature/app/styles/main-queso.scss` - Starter styles for CSS framework
96- `/__common__/app/styles/_typography-queso.scss` - Extra typography styles not accounted for in queso-ui and data viz specific overrides of existing helpers. Appended `-queso` as to not be confused with current _typography.scss
97- `/feature/app/styles/components/_navbar.scss` - Overrides for queso navbar
98- `feature/app/styles/layout/_container.scss` - Additional container classes
99- `/feature/app/templates/components/navbar.html` - Standard navbar component (used on TT)
100- `/feature/app/templates/components/share.html` - Standard share component (used on TT)
101- `/feature/app/templates/includes/logo.html` - Standard logo include (used on TT)
102
103### Changed
104- `_package.json` - Added queso dependency
105- `_variables.scss` - Added variables required for queso
106- `/feature/app/scripts/components/RelatedContent.js` and `/feature/app/scripts/components/Story.js` - Sprinkled in queso helpers (to be compatible in either starter template)
107- `/feature/app/styles/components/_ads.scss` - Updated teal to match TT site (it's a random darkened-teal for accessibility)
108- `/feature/app/styles/main.scss` - Removed sass-mq because it comes with the queso imports and added just the base queso variables and tools. This doesn't actually add any CSS so it's helpful if you ever want to include queso helpers in this file in your project.
109- `/feature/app/templates/base.html` - Added more blocks so that the queso starter template could vary in those parts. Example: Google fonts isn't needed in the queso started so we override that with an empty block.
110
111## [2.7.2] - 2020-07-01
112### Added
113- `templates/feature/app/scripts/packs/graphic.js` - add useful functions to JS for graphics (functions were already available in feature JS)
114
115### Fixed
116- `templates/feature/app/templates/includes/ldjson.html` - check for `updated` or `update date` so the tracker shows up in search on updates, add `author` field
117
118## [2.7.1] - 2020-07-01
119### Added
120- `templates/__common__/app/styles/_typography.scss` - add styling for update date #44
121
122### Changed
123- `templates/feature/app/index.html` - add HTML to handle update date and pub date #44
124
125### Fixed
126- `templates/feature/app/scripts/utils/feeds.js` - switch v1 API urls to v2 API urls #6
127- `templates/feature/app/scripts/components/Story.js` - switch out properties to match v2 API urls #6
128
129## [2.7.0] - 2020-07-01
130### Added
131- `templates/__common__/config/tasks/templates.js` - add renderStringWithNunjucks() filter to process data variables pulled in from a Google Doc #46
132- `templates/graphic/app/templates/macros/processors.html`, `templates/feature/app/templates/macros/processors.html` - separate processors files for graphics and features, add renderStringWithNunjucks() filter to macros #46
133
134### Changed
135- `templates/feature/app/index.html` - set featureData variable to store data
136- `templates/graphic/app/index.html`, `templates/graphic/app/static.html` - set graphicData variable to store data, render graphic prose with prose macro so we can add data variables
137
138### Removed
139- `templates/__common__/app/templates/macros/processors.html` - remove common processors file
140
141## [2.6.0] - 2020-05-08
142### Added
143- `templates/__common__/config/tasks/unused-css.js` - A step that looks at the CSS file linked in any .html file, parses that CSS, and writes new CSS based only on what the HTML needs through the magic of this wonderful tool, [purgecss](https://github.com/FullHuman/purgecss)
144
145### Changed
146- `templates/__common__/config/scripts/build.js` - This cleanup step will now run right after the HTML of the templates compile and before the file revving step
147- `templates/__common__/config/tasks/serve.js` - New watchers added mostly in the build output folder to re-run the CSS cleanup step after the build
148- `templates/__common__/_package.json` - Adds purgecss as a dev dependency
149
150## [2.5.3] - 2020-04-21
151### Added
152- `_variables.scss` - add elections color palette
153- `deploy.js` - add reminder to check social media for features and fetch the latest data
154- `README.md` - update feature README with more publication reminders
155
156## [2.4.3] - 2020-02-11
157### Fixed
158- `package.json` - removed `npm run assets:pull` from the `predeploy` command #39
159
160## [2.4.2] - 2020-01-15
161### Changed
162- `package.json` - pull assets and push to workspace on predeploy, which is run automatically before deploy #31
163- `feature/app/styles/components/_related-content.scss`, `feature/app/styles/components/_ads.scss`,
164`processors.html` - update appearance of ads
165- `graphic/README.md, feature/README.md` - added project launch checklist
166
167## [2.4.1]
168### Changed
169- `update-log-sheet.js` - change sheet to new 2020 data visuals work sheet
170
171## [2.4.0]
172### Added
173- `_polls.scss`, `_variables.scss`, `_graphic.scss`, `mixins/_grid.scss` — add styles needed for poll graphics
174- `templates.js`, `nunjucks.js` — add helpers needed for poll graphics
175
176## [2.3.2] - 2019-11-26
177### Changed
178- `graphic/app/scripts/embeds/frames.js` - don't pass debounced function to resize listener, simplify code #29
179
180## [2.3.1] - 2019-11-15
181### Fixed
182- `deploy.js` - add property to iframe sandbox so user can click to other pages #25
183- `project.config.js` - change default archieML doc to be the one we actually use #26
184- `update-log-sheet.js` - add year to repo name for `newsapps-dailies` graphics (post reorganization of our dailies)
185
186## [2.3.0] - 2019-10-28
187### Changed
188- `feature/app/templates/components/simple-masthead.html` - switch out normal logo for 10th anniversary logo
189
190## [2.2.1] - 2019-10-22
191### Fixed
192- `__common__/utils/deployment/update-log-sheet.js` - handle cases when there are no files specified in the config file
193
194## [2.2.0] - 2019-10-17
195### Added
196- `__common__/app/templates/macros/processors.html` - add ad macro to processors file #16
197- `feature/app/scripts/packs/graphic.js` - add graphic pack for code in a feature with resize() function #22
198
199### Changed
200- `feature/app/index.html` - import ad from processors file #16
201- `feature/app/scripts/packs/main.js` - import new graphic pack
202- `graphic/app/scripts/packs/graphic.js` - fixed data path
203
204### Removed
205- `feature/app/templates/macros/ads.html` - remove special ad macro from feature #16
206
207## [2.1.0] - 2019-10-17
208### Changed
209- `_common_/utils/deployment/deploy.js` - change deploy function to update log sheet and README #20
210- `_common_/utils/fetch/authorize.js`- change SCOPES to include write permissions #20
211- `project.config.js` for graphics and features - add `createDate` and `slug` property
212
213### Added
214- `_common_/utils/deployment/update-log-sheet.js` - add utility file for adding to data visuals log sheet #20
215- `_common_/utils/deployment/update-readme.js` - add utility file for adding links to README #20
216
217## [2.0.0] - 2019-09-25
218### Added
219- `graphic/app/styles/raw-plugin-styles.html` - add styles snippet that goes into the CSS content section of Raw Plugins
220- `graphic/app/static.html` - template for non-scripted graphics
221- `graphic/app/scripts/static.js` - pack for non-scripted graphics
222
223### Changed
224- Switched from using Pym to `frames` library #17
225
226### Removed
227- `graphic/app/scripts/embeds/pym.js`
228
229## [1.2.0] - 2019-09-19
230### Fixed
231- Fixed security vulnerability introduced by `lodash` #10
232
233### Added
234- Added `widont` tag to graphic and feature templates #11
235- Added a CHANGELOG #13
236- Added a subheader example to the feature template #14
237- Added a subheader macro #14
238- Added styling for a subheader #14
239
240## [1.1.1] - 2019-05-08
241* Change GA event tags
242
243## [1.1.0] - 2019-04-03
244- Redundant ternary a828d34
245- Better default doc and sheet examples b8abc16
246- Merge branch 'master' into develop d82ebed
247- Make https serving an option set with an env variable 1310cdb
248
249https://github.com/texastribune/data-visuals-create/compare/1.0.1...1.1.0
250
251## [1.0.1] - 2019-03-20
252- Fix bug in doc-to-archieml parser with lists 6717876
253- Update Getting started with right path 5d24a29
254
255https://github.com/texastribune/data-visuals-create/compare/1.0.0...1.0.1
256
257## [1.0.0] - 2019-03-05
258
259## [1.0.0-alpha] - 2019-02-27
260
261## [0.36.0] - 2019-02-19
262
263## [0.35.0] - 2019-01-29
264
265## [0.34.1] - 2019-01-14
266
267## [0.34.0] - 2019-01-11
268
269## [0.33.0] - 2018-12-04