| 1 | # Changelog
|
| 2 |
|
| 3 | All notable changes to this project will be documented in this file.
|
| 4 |
|
| 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
| 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
| 7 |
|
| 8 | > - **Added** for new features.
|
| 9 | > - **Changed** for changes in existing functionality.
|
| 10 | > - **Deprecated** for soon-to-be removed features.
|
| 11 | > - **Removed** for now removed features.
|
| 12 | > - **Fixed** for any bug fixes.
|
| 13 | > - **Security** in case of vulnerabilities.
|
| 14 |
|
| 15 | # Unreleased
|
| 16 |
|
| 17 | - _(Add a summary of your feature, and if relevant the issue, in your PR for merging into `main`)_
|
| 18 |
|
| 19 | # Released
|
| 20 |
|
| 21 | ## [0.11.0] - 2022-10-03
|
| 22 |
|
| 23 | ### Added
|
| 24 |
|
| 25 | - Introduced average and marginal carbon intensity data into the library. This comes from [Ember Climate](https://ember-climate.org/data/data-explorer/) (for average carbon intensity data), and [The Green Web Foundation](https://developers.thegreenwebfoundation.org/co2js/data) (marginal intensity data, originally sourced from the UNFCCC - the United Nations Framework Convention on Climate Change). For more, [see our release guide for v0.11](https://www.thegreenwebfoundation.org/news/release-guide-co2-js-v0-11/) about the differences between the kinds of data. See [#64](https://github.com/thegreenwebfoundation/co2.js/issues/64), and [#97](https://github.com/thegreenwebfoundation/co2.js/issues/97) for more.
|
| 26 | - Added new paths to `import` and `require` the annual, country-level average and marginal carbon intensity data mentioned above like, as javascript objects, or as JSON. See [#104 for more](https://github.com/thegreenwebfoundation/co2.js/issues/104).
|
| 27 | - Added links to CO2.js in forms already available on CDNs to avoid needing to npm install it to try it out. See [#105 for more](https://github.com/thegreenwebfoundation/co2.js/issues/105).
|
| 28 | - Introduced scripts to automate the generation of grid intensity data based of Ember & UNFCCC source files.
|
| 29 | - Introduced a `release:minor` command, to automate the publishing process, to complement `release:patch`.
|
| 30 |
|
| 31 | ### Changed
|
| 32 |
|
| 33 | - Changed the default model for transfer based CO2 calculations from the _1byte_ model to the _Sustainable Web Design_ model instead. See https://developers.thegreenwebfoundation.org/co2js/models/ for guidance on the differences and how to migrate between them. See [#94 for more](https://github.com/thegreenwebfoundation/co2.js/issues/94).
|
| 34 | - Updated our release commands to generate and format the carbon intensity data as part of the release process.
|
| 35 |
|
| 36 | ## 0.10.4 2022-08-12
|
| 37 |
|
| 38 | ### Added
|
| 39 |
|
| 40 | - Introduced a `release:patch` command, to automate the publishing process. This is designed to make sure we always publish the most recent compiled code, by adding a rebuild step that can be easy to forget.
|
| 41 |
|
| 42 | ## 0.10.3 2022-08-12
|
| 43 |
|
| 44 | ### Added
|
| 45 |
|
| 46 | - Introduced a new `perVisit()` function for the Sustainable Web Design model, which applies [caching and return visits assumptions](https://sustainablewebdesign.org/calculating-digital-emissions/).
|
| 47 |
|
| 48 | ## [0.10.2] - 2022-08-12
|
| 49 |
|
| 50 | - Added the ability to set the model used by CO2.js to the Sustainable Web Design model, using a simple 'swd' string, instead of needing to pass in a class.
|
| 51 |
|
| 52 | ## [0.10.1] - 2022-08-01
|
| 53 |
|
| 54 | This release used a version bump as previously we had released v0.10.0 under a pre-release tag.
|
| 55 |
|
| 56 | ## [0.10.0] - 2022-06-27
|
| 57 |
|
| 58 | - Added ES import syntax as the main way for handling imports and exports of code within the module.
|
| 59 | - Changed eslint settings to use later version of ecmascript (2020)
|
| 60 | - Change the build tools to use esbulid with jest instead of babel
|
| 61 | - Added more consistent use of the debug logging library in files using the updated import syntax
|
| 62 | - Fixed the incorrect order of FIRST_TIME_VIEWING_PERCENTAGE and RETURNING_VISITOR_PERCENTAGE constants in the SWD model. This will result in **larger** values for calculations using the sustainable web design, and the default caching assumptions.
|
| 63 |
|
| 64 | ## [0.9.0] - 2022-03-28
|
| 65 |
|
| 66 | ### Added
|
| 67 |
|
| 68 | - Added newly implemented Sustainable Web Design model [thanks @dryden!]
|
| 69 | - Added new readme page for using both emissions models
|
| 70 | - Added new source of data to the Sustainable Web Design model from Ember Climate.
|
| 71 |
|
| 72 | ### Changed
|
| 73 |
|
| 74 | - Changed the CO2 class to accept either the One Byte model or the Sustainable Web Design model
|
| 75 |
|
| 76 | ### Fixed
|
| 77 |
|
| 78 | - Fixed various typos.
|
| 79 |
|
| 80 | ## [0.8.0] - 2021-11-28
|
| 81 |
|
| 82 | ### Fixed
|
| 83 |
|
| 84 | - Update further dependencies
|
| 85 | - Fix embarassing order of magnitude typo in 1byte model (thanks @mstaschik!)
|
| 86 |
|
| 87 | ## Added
|
| 88 |
|
| 89 | - Read JSON blob also as gzipped #44 (thanks @soulgalore)
|
| 90 |
|
| 91 | ### Changed
|
| 92 |
|
| 93 | - The 1byte model will give different numbers now. It's mentioned in `#fixed` but it's worth repeating.
|
| 94 |
|
| 95 | ## [0.7.0] - 2021-11-28
|
| 96 |
|
| 97 | ### Fixed
|
| 98 |
|
| 99 | - Update tests to avoid network requests #50
|
| 100 | - Update dependencies across the board
|
| 101 |
|
| 102 | ### Changed
|
| 103 |
|
| 104 | - Switch to github actions instead of travis for CI.
|
| 105 |
|
| 106 | ## [0.6.1] - 2020-03-15
|
| 107 |
|
| 108 | ### Fixed
|
| 109 |
|
| 110 | - Added the function to load JSON, on the tgwg.hosting object, for use in the sustaiable web sitespeed plugin.
|
| 111 |
|
| 112 | ## [0.6.0] - 2020-03-15
|
| 113 |
|
| 114 | ### Added
|
| 115 |
|
| 116 | - Added the hosting-JSON for running local checks against an array instead of SQLite.
|
| 117 |
|
| 118 | ### Changed
|
| 119 |
|
| 120 | - Swapped out checking against a sqlite database `hosting-json`in favour of simple array in,
|
| 121 | - Updated conventions for style - using kebab-cases over CamelCase for naming files
|
| 122 |
|
| 123 | ### Removed
|
| 124 |
|
| 125 | - Extracted sqlite usage and dependencies into a separate module, `url2green`. This means you no longer need to compile SQLite on install.
|
| 126 |
|
| 127 | ## [0.5.0] - 2020-03-03
|
| 128 |
|
| 129 | ### Changed
|
| 130 |
|
| 131 | - Updated README
|
| 132 | - Updated the emissions figured for green energy after further research on methodology with @@JamieBeevor
|
| 133 | - Incorporated class based CO2 models from @soulgalore
|
| 134 | - Credit contributors
|
| 135 |
|
| 136 | ## [0.4.7] - 2020-03-02
|
| 137 |
|
| 138 | ### Added
|
| 139 |
|
| 140 | - Added a changelog at last!
|
| 141 |
|
| 142 | ## [0.4.6] - 2020-03-01
|
| 143 |
|
| 144 | ### Added
|
| 145 |
|
| 146 | - Changelog inconsistency section in Bad Practices
|
| 147 |
|
| 148 | ## [0.4.4] - 2020-03-01
|
| 149 |
|
| 150 | ### Added
|
| 151 |
|
| 152 | Added the (currently unused) green byte model.
|
| 153 |
|
| 154 | ### Changed
|
| 155 |
|
| 156 | Update the 1byte model to use an average of devices, rather than just wifi
|
| 157 |
|
| 158 | ## [0.4.3] - 2020-03-01
|
| 159 |
|
| 160 | ### Added
|
| 161 |
|
| 162 | ### Changed
|
| 163 |
|
| 164 | Split hosting API into two separate files (one for sqlite, and one relying on the greencheck API)
|