Repository navigation
1.2.0.beta changelog - #8529
1.2.0.beta changelog#8529
Conversation
asheemmamoowala
left a comment
There was a problem hiding this comment.
This is a good start, but I think a lot of items have snuck in from the v1.1.1 release, but also a couple from older ones.
Could also use more developer-friendly entries than just the titles from the corresponding PRs/commits
| * Add map-specific access tokens ([#8364](https://github.com/mapbox/mapbox-gl-js/pull/8364)) | ||
| * Get start-docs working on linux ([#8486](https://github.com/mapbox/mapbox-gl-js/pull/8486)) | ||
| * Add *-sort-key layout property for circle, fill, line ([#8467](https://github.com/mapbox/mapbox-gl-js/pull/8467)) | ||
| * Include Hiragana and Katakana code blocks for local glyph generation ([#8365](https://github.com/mapbox/mapbox-gl-js/pull/8365)) |
There was a problem hiding this comment.
This was previously released with 1.1
| * Get start-docs working on linux ([#8486](https://github.com/mapbox/mapbox-gl-js/pull/8486)) | ||
| * Add *-sort-key layout property for circle, fill, line ([#8467](https://github.com/mapbox/mapbox-gl-js/pull/8467)) | ||
| * Include Hiragana and Katakana code blocks for local glyph generation ([#8365](https://github.com/mapbox/mapbox-gl-js/pull/8365)) | ||
| * Use browser `Cache` interface to cache tiles ([#8363](https://github.com/mapbox/mapbox-gl-js/pull/8363)) |
There was a problem hiding this comment.
This was previously released with 1.1
| * Include Hiragana and Katakana code blocks for local glyph generation ([#8365](https://github.com/mapbox/mapbox-gl-js/pull/8365)) | ||
| * Use browser `Cache` interface to cache tiles ([#8363](https://github.com/mapbox/mapbox-gl-js/pull/8363)) | ||
| * Make requirements for text offset props more precise ([#8418](https://github.com/mapbox/mapbox-gl-js/pull/8418)) | ||
| * Refactor normalize and canonicalize URL methods ([#8456](https://github.com/mapbox/mapbox-gl-js/pull/8456)) |
There was a problem hiding this comment.
Internal refactors don't need a changelog entry
| * Opaque pass layers now render properly over heatmap and fill-extrusion layers ([#8440](https://github.com/mapbox/mapbox-gl-js/pull/8440)) | ||
| * Turn off 'move' event listeners when removing a marker ([#8465](https://github.com/mapbox/mapbox-gl-js/pull/8465)) | ||
| * Favor previous anchor only when still in the `text-variable-anchor` options ([#8473](https://github.com/mapbox/mapbox-gl-js/pull/8473)) | ||
| * Fix vector tile line rendering regression `bug` ([#8477](https://github.com/mapbox/mapbox-gl-js/issues/8477), fixed by [#8479](https://github.com/mapbox/mapbox-gl-js/pull/8479)) |
| * Turn off 'move' event listeners when removing a marker ([#8465](https://github.com/mapbox/mapbox-gl-js/pull/8465)) | ||
| * Favor previous anchor only when still in the `text-variable-anchor` options ([#8473](https://github.com/mapbox/mapbox-gl-js/pull/8473)) | ||
| * Fix vector tile line rendering regression `bug` ([#8477](https://github.com/mapbox/mapbox-gl-js/issues/8477), fixed by [#8479](https://github.com/mapbox/mapbox-gl-js/pull/8479)) | ||
| * Fix malformed URLs generated from normalizeTileURL and makeAPIURL (h/t @sumarlidason) ([#8466](https://github.com/mapbox/mapbox-gl-js/pull/8466)) |
There was a problem hiding this comment.
nit: sumarlidason is a mapbox-contributor
| * Fix Response construction in Edge ([#8392](https://github.com/mapbox/mapbox-gl-js/pull/8392)) | ||
| * Fix class toggling on control for IE ([#8495](https://github.com/mapbox/mapbox-gl-js/pull/8495)) (h/t [cs09g](https://github.com/cs09g)) | ||
| * Fix background rotation hovering ([#8367](https://github.com/mapbox/mapbox-gl-js/pull/8367)) (h/t [GuillaumeGomez](https://github.com/GuillaumeGomez)) | ||
| * Fix broken map-tiles example ([#8482](https://github.com/mapbox/mapbox-gl-js/pull/8482)) |
There was a problem hiding this comment.
Doesn't need Changelog entry - fix was pushed directly to publisher-production.
| * Fix class toggling on control for IE ([#8495](https://github.com/mapbox/mapbox-gl-js/pull/8495)) (h/t [cs09g](https://github.com/cs09g)) | ||
| * Fix background rotation hovering ([#8367](https://github.com/mapbox/mapbox-gl-js/pull/8367)) (h/t [GuillaumeGomez](https://github.com/GuillaumeGomez)) | ||
| * Fix broken map-tiles example ([#8482](https://github.com/mapbox/mapbox-gl-js/pull/8482)) | ||
| * Fix unbounded memory growth in IE ([#8490](https://github.com/mapbox/mapbox-gl-js/pull/8490)) |
| * Fix background rotation hovering ([#8367](https://github.com/mapbox/mapbox-gl-js/pull/8367)) (h/t [GuillaumeGomez](https://github.com/GuillaumeGomez)) | ||
| * Fix broken map-tiles example ([#8482](https://github.com/mapbox/mapbox-gl-js/pull/8482)) | ||
| * Fix unbounded memory growth in IE ([#8490](https://github.com/mapbox/mapbox-gl-js/pull/8490)) | ||
| * Get map to load in Edge over http ([#8411](https://github.com/mapbox/mapbox-gl-js/issues/8411), fixed by [#8415](https://github.com/mapbox/mapbox-gl-js/pull/8415)) |
| * Get map to load in Edge over http ([#8411](https://github.com/mapbox/mapbox-gl-js/issues/8411), fixed by [#8415](https://github.com/mapbox/mapbox-gl-js/pull/8415)) | ||
| * Fix error in certain click events on markers ([#8462](https://github.com/mapbox/mapbox-gl-js/pull/8462)) (h/t [@msbarry](https://github.com/msbarry)) | ||
| * Fix SDK support spec section for variable label placement ([#8384](https://github.com/mapbox/mapbox-gl-js/pull/8384)) (h/t [@pozdnyakov](https://github.com/pozdnyakov)) | ||
| * Fix regression in tile load times ([#8431](https://github.com/mapbox/mapbox-gl-js/issues/8431), fixed by [#8434](https://github.com/mapbox/mapbox-gl-js/pull/8434)) |
There was a problem hiding this comment.
Could use a better description
|
|
||
| ## 13.7.1 | ||
|
|
||
|
|
There was a problem hiding this comment.
nit: unneccessary newline
| * Get start-docs working on linux ([#8486](https://github.com/mapbox/mapbox-gl-js/pull/8486)) | ||
| * Add *-sort-key layout property for circle, fill, line ([#8467](https://github.com/mapbox/mapbox-gl-js/pull/8467)) | ||
| * Make requirements for text offset props more precise ([#8418](https://github.com/mapbox/mapbox-gl-js/pull/8418)) | ||
| * Get Codegen to remove extraneous newlines. ([6fdbdeb](https://github.com/mapbox/mapbox-gl-js/commit/6fdbdebd25de292ab1d42e4e6beff05fbf696d2e)) |
There was a problem hiding this comment.
This shouldn't be in changelog (no user-facing changes) and this is addressing an earlier PR in the same release.
| * Add *-sort-key layout property for circle, fill, line ([#8467](https://github.com/mapbox/mapbox-gl-js/pull/8467)) | ||
| * Make requirements for text offset props more precise ([#8418](https://github.com/mapbox/mapbox-gl-js/pull/8418)) | ||
| * Get Codegen to remove extraneous newlines. ([6fdbdeb](https://github.com/mapbox/mapbox-gl-js/commit/6fdbdebd25de292ab1d42e4e6beff05fbf696d2e)) | ||
| * Update integration dependencies ([#8354](https://github.com/mapbox/mapbox-gl-js/pull/8354)) |
There was a problem hiding this comment.
This is only relevant for core contributors.
| * Add map-specific access tokens ([#8364](https://github.com/mapbox/mapbox-gl-js/pull/8364)) | ||
| * Explicit source options now take precedence over TileJSON ([#8232](https://github.com/mapbox/mapbox-gl-js/pull/8232)) (h/t [jingsam](https://github.com/jingsam)) | ||
| * Accommodate prefers-reduced-motion settings in browser ([#8494](https://github.com/mapbox/mapbox-gl-js/pull/8494)) | ||
| * Tilt compass as the map pitches ([#8208](https://github.com/mapbox/mapbox-gl-js/issues/8208), fixed by [#8296](https://github.com/mapbox/mapbox-gl-js/pull/8296)) (h/t [pakastin](https://github.com/pakastin)) |
There was a problem hiding this comment.
Compass isn't tilted by default so I would clarify that as "Add Map visualizePitch option that ...".
| * Add sdk support spec section for text-radial-offset ([#8401](https://github.com/mapbox/mapbox-gl-js/pull/8401)) | ||
|
|
||
| ## Bug fixes | ||
| * Opaque pass layers now render properly over heatmap and fill-extrusion layers ([#8440](https://github.com/mapbox/mapbox-gl-js/pull/8440)) |
There was a problem hiding this comment.
For consistency, let's keep items in the same form (i.e. "Fix rendering of ....")
| * Opaque pass layers now render properly over heatmap and fill-extrusion layers ([#8440](https://github.com/mapbox/mapbox-gl-js/pull/8440)) | ||
| * Turn off 'move' event listeners when removing a marker ([#8465](https://github.com/mapbox/mapbox-gl-js/pull/8465)) | ||
| * Favor previous anchor only when still in the `text-variable-anchor` options ([#8473](https://github.com/mapbox/mapbox-gl-js/pull/8473)) | ||
| * Fix vector tile line rendering regression ([#8477](https://github.com/mapbox/mapbox-gl-js/issues/8477), fixed by [#8479](https://github.com/mapbox/mapbox-gl-js/pull/8479)) |
There was a problem hiding this comment.
That's too broad. The PR fixes artifacts on tiles where lines go past allowed extent, and also fixes warning about this not appearing.
| * Turn off 'move' event listeners when removing a marker ([#8465](https://github.com/mapbox/mapbox-gl-js/pull/8465)) | ||
| * Favor previous anchor only when still in the `text-variable-anchor` options ([#8473](https://github.com/mapbox/mapbox-gl-js/pull/8473)) | ||
| * Fix vector tile line rendering regression ([#8477](https://github.com/mapbox/mapbox-gl-js/issues/8477), fixed by [#8479](https://github.com/mapbox/mapbox-gl-js/pull/8479)) | ||
| * Fix malformed URLs generated from normalizeTileURL and makeAPIURL ([#8466](https://github.com/mapbox/mapbox-gl-js/pull/8466)) |
There was a problem hiding this comment.
normalizeTileURL and makeAPIURL are internal functions that are not exposed publicly, so this needs to be rephrased to reflect what changes on the user side. E.g. "Fix malformed urls when using custom baseAPIURL of a certain form".
| * Fix class toggling on navigation control for IE ([#8495](https://github.com/mapbox/mapbox-gl-js/pull/8495)) (h/t [cs09g](https://github.com/cs09g)) | ||
| * Fix background rotation hovering on geolocate control ([#8367](https://github.com/mapbox/mapbox-gl-js/pull/8367)) (h/t [GuillaumeGomez](https://github.com/GuillaumeGomez)) | ||
| * Fix error in click events on markers where startPos is not defined ([#8462](https://github.com/mapbox/mapbox-gl-js/pull/8462)) (h/t [@msbarry](https://github.com/msbarry)) | ||
| * Fix SDK support spec section for variable label placement ([#8384](https://github.com/mapbox/mapbox-gl-js/pull/8384)) (h/t [@pozdnyakov](https://github.com/pozdnyakov)) |
There was a problem hiding this comment.
Both "SDK support spec section ..." items aren't clear for GL JS users. How they really experience this change is updated version support tables in docs, which I'm not sure we should surface in this changelog.
| ## 1.2.0 | ||
|
|
||
| ## Features and improvements | ||
| * Add *-sort-key layout property for circle, fill, line ([#8467](https://github.com/mapbox/mapbox-gl-js/pull/8467)) |
There was a problem hiding this comment.
Could we add a few words about what this style-spec property enables? e.g.
Add *-sort-key layout property for circle, fill, line layers to enable sorting features within a single layer
There was a problem hiding this comment.
I would also prefer that we use the `` around style-spec property names; I'm not sure if this is a convention we've been following in practice. so that this entry would say *-sort-key
|
|
||
| ## Features and improvements | ||
| * Add *-sort-key layout property for circle, fill, line ([#8467](https://github.com/mapbox/mapbox-gl-js/pull/8467)) | ||
| * Add map-specific access tokens ([#8364](https://github.com/mapbox/mapbox-gl-js/pull/8364)) |
There was a problem hiding this comment.
What does this do? If it's not that important, it should be lower in the changelog; if it is that important, its importance and impact should be clearer in the changelog entry
There was a problem hiding this comment.
It enables users to add maps with access tokens specific to the map, but I'm struggling to make that more clear beyond switching the words around 🤔as for importance, there aren't many other big feature enhancements in this release overall, hence the prioritization
| ## Features and improvements | ||
| * Add *-sort-key layout property for circle, fill, line ([#8467](https://github.com/mapbox/mapbox-gl-js/pull/8467)) | ||
| * Add map-specific access tokens ([#8364](https://github.com/mapbox/mapbox-gl-js/pull/8364)) | ||
| * Make requirements for text offset props more precise ([#8418](https://github.com/mapbox/mapbox-gl-js/pull/8418)) |
There was a problem hiding this comment.
Could we limit non-standard abbreviations ("props") and try to be more precise about style-spec property names? e.g. for this entry:
Clarify requirements and restrictions for
text-variable-anchor,text-radial-offset,text-offsetandtext-anchorproperties in documentation
| * Make requirements for text offset props more precise ([#8418](https://github.com/mapbox/mapbox-gl-js/pull/8418)) | ||
| * Accommodate prefers-reduced-motion settings in browser ([#8494](https://github.com/mapbox/mapbox-gl-js/pull/8494)) | ||
| * Add Map visualizePitch option that tilts the compass as the map pitches ([#8208](https://github.com/mapbox/mapbox-gl-js/issues/8208), fixed by [#8296](https://github.com/mapbox/mapbox-gl-js/pull/8296)) (h/t [pakastin](https://github.com/pakastin)) | ||
| * Explicit source options now take precedence over TileJSON ([#8232](https://github.com/mapbox/mapbox-gl-js/pull/8232)) (h/t [jingsam](https://github.com/jingsam)) |
There was a problem hiding this comment.
This entry doesn't meet GL-JS documentation requirements for starting with a verb. Could be rephrased as:
Allow explicit source options to take precedence over TileJSON
or
Make explicit source options take precedence over TileJSON
|
|
||
| ## Bug fixes | ||
| * Fix rendering of opaque pass layers over heatmap and fill-extrusion layers ([#8440](https://github.com/mapbox/mapbox-gl-js/pull/8440)) | ||
| * Favor previous anchor only when still in the `text-variable-anchor` options ([#8473](https://github.com/mapbox/mapbox-gl-js/pull/8473)) |
There was a problem hiding this comment.
I don't think this PR name is clear as a changelog entry and would prefer:
Fix bug where previous anchors set in
text-variable-anchorwere still preferred after anchor options were reset
There was a problem hiding this comment.
the change emphasizes that previous positions would get prioritized only if they're also present in the updated style value, but i'll figure out a way to articulate that
|
@peterqliu, I did a pass through merged PRs for notable PRs that might be missing from the changelog. I think the only things are the caching fixes @ansis made: I'd say
should definitely be included in the 1.2 changelog; #8392 also looks significant enough to me for the changelog, since this regression was released in 1.1 and cherrypicked & fixed in 1.1.1. However, I noticed it also wasn't included in the 1.1.1 changelog, so I guess it could be clearer to exclude the fix from both changelogs. |
chloekraw
left a comment
There was a problem hiding this comment.
LGTM % a few comments to consider
| * Expose `convertFilter` API in the style specification ([#8493](https://github.com/mapbox/mapbox-gl-js/pull/8493) | ||
|
|
||
| ## Bug fixes | ||
| * BREAKING: Fix changes to `text-variable-anchor`, such that previous anchor positions would take precedence only if they are present in the updated array (considered a bug fix, but is technically a breaking change from previous behavior) ([#8473](https://github.com/mapbox/mapbox-gl-js/pull/8473)) |
There was a problem hiding this comment.
Hmmm, was this change made based on feedback from @mourner or @asheemmamoowala? If so, LGTM.
If not: specifying a breaking change like this is confusing to me as a user. I would prefer the following:
- Remove "BREAKING:" from the changelog and leave it in the bug fix section with the parenthetical note as-is, OR
- Flag as a breaking change in its own section like we would usually do (see https://github.com/mapbox/mapbox-gl-js/releases/tag/v1.0.0 for an example) and note that it also fixes a bug
I prefer option 1 -- I don't think that the impact of this change is large or will break customers' maps in unexpected ways.
| ## 1.2.0 | ||
|
|
||
| ## Features and improvements | ||
| * Add `*-sort-key` layout property for circle, fill, and line layers, to sort the z-index of features within a single layer([#8467](https://github.com/mapbox/mapbox-gl-js/pull/8467)) |
There was a problem hiding this comment.
I'm not sure how much this distinction matters, but *-sort-key impacts the draw order of features which is what makes it appear as though it's possible to sort features within a layer. Now that I'm reading this changelog entry with the addition of "z-index," it adds a level of precision that now makes the changelog entry feel less accurate to me, but I would defer to @ahk on this.
I'd probably prefer "...to control the draw order of features..." or the more general "to sort features within a single layer."
There was a problem hiding this comment.
How about "Add *-sort-key layout property for circle, fill, and line layers. Allows specifying the order that features are drawn within a layer."
| @@ -1,3 +1,26 @@ | |||
| ## 1.2.0 | |||
|
|
|||
| ## Features and improvements | |||
There was a problem hiding this comment.
nit: subtopics of the version should be H3 aka ### . Could use an edit to v1.1.1 as well
There was a problem hiding this comment.
oof, great callout @asheemmamoowala but we've done this incorrectly for many releases. e.g. https://github.com/mapbox/mapbox-gl-js/releases?after=v0.50.0-beta.1 and https://github.com/mapbox/mapbox-gl-js/releases?after=v1.0.0
|
@chloekraw @peterqliu since all the caching fixes were included in v1.1.1, why would we include them in v1.2.0? Changelog should reflect changes since the previous version, not the previous minor version, so duplicating these entries would be confusing. |
|
@mourner ahh ok, that makes sense. I'm indifferent as to whether we let this one be or we open a new pr to fix it. It seems small enough that it's probably not a huge deal either way. I'm accustomed to publishing a retroactive patch release (e.g. 5.1.1) after the latest minor release (5.2) has been published, in which case, a patch's changelog would still contain bug fix entries from the latest minor release. |
@chloekraw that's a reverse situation — a retroactive v5.1.1 release would show changes vs the previous release relative to it (v5.1.0). v1.2.0 on the other hand is not retroactive — it contains all the fixes v1.1.1 has. |
|
yep! I'm agreeing with you; I was sharing that I missed how this convention (to only show changes since the previous release) impacts changelogs when there is a patch because I'm accustomed to the reverse situation. |
|
I'm all for fixing this and the heading in a new pr if that's still easy to do at this stage of the release. |
* origin/publisher-production: update version to v1.2.0 (#8562) Fix usage of String.includes which is es6 but not transformed by buble (#8565) (#8573) [docs] fix missing location prop to feedback component (#8554) Fix typo [docs] update dr-ui (#8548) [docs] fix errors on IE11 caused by dr-ui dependencies (#8544) updates directions plugin version (#8536) add dds sdk support squash (#8529) [docs] adds feedback component (#8507)
No description provided.