Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update changelog for 3.0 release #2854

Merged
merged 25 commits into from
Jan 6, 2022
Merged

Update changelog for 3.0 release #2854

merged 25 commits into from
Jan 6, 2022

Conversation

calebmshafer
Copy link
Member

During 3.0 we started adding all of the changes in whatever order happened to be the easiest. In this PR, re-organize and update the docs to portray all of the changes made in a more consumable way.

The layout going for in the PR is;

  1. Quick intro to the high level goals of 3.0
  2. Transition Guide
    1. Highlight the new codemod tool as a way to get started. Then point to the Breaking Changes list of the 4 point
  3. New features added
    • Group by set of functionality to make more consumable
  4. Breaking changes organized by group of functionality
  5. Renaming tables
    • These should all be covered by the codemod so not as important as everything else in the docs.

@calebmshafer calebmshafer requested a review from pmconne December 7, 2021 14:44
@calebmshafer
Copy link
Member Author

@pmconne pushed up what I've done so far. I have some other changes to call out all of the authorization changes but I'll push that soon.

@williamkbentley
Copy link
Member

## Remove ninezone-test-app appears on lines 1032 and 1118

@calebmshafer calebmshafer marked this pull request as ready for review January 5, 2022 16:13
@calebmshafer calebmshafer requested a review from a team as a code owner January 5, 2022 16:14
@calebmshafer calebmshafer requested a review from a team as a code owner January 6, 2022 09:26
@grigasp
Copy link
Member

grigasp commented Jan 6, 2022

While looking for new stuff that we added for 3.0 I scanned through the changelog JSONs. I'm not sure how often consumers look at them, but it seems they need to be cleaned up as well. IMO they should only mention stuff that's relevant for a person consuming the package, but some of them contain completely irrelevant messages.

For example one of the messages for presentation-backend is: "remove requestContext argument from importSchemas". That has absolutely no meaning to someone using presentation-backend package.

Should we clean them up in this PR?

@calebmshafer
Copy link
Member Author

While looking for new stuff that we added for 3.0 I scanned through the changelog JSONs. I'm not sure how often consumers look at them, but it seems they need to be cleaned up as well. IMO they should only mention stuff that's relevant for a person consuming the package, but some of them contain completely irrelevant messages.

For example one of the messages for presentation-backend is: "remove requestContext argument from importSchemas". That has absolutely no meaning to someone using presentation-backend package.

Should we clean them up in this PR?

@grigasp sure, you can make that update within this PR. I think everyone should take a pass at these since I suspect most people will find messages that are not helpful to users.

@pmconne
Copy link
Member

pmconne commented Jan 6, 2022

@calebmshafer I thought @scsewall intended the changelogs to be reviewed and sanitized for every release (major, minor, patch) - are we not doing that?
Far too many people simply duplicate their non-user-friendly and/or uninteresting commit messages when doing rush change.

@calebmshafer
Copy link
Member Author

@calebmshafer I thought @scsewall intended the changelogs to be reviewed and sanitized for every release (major, minor, patch) - are we not doing that?
Far too many people simply duplicate their non-user-friendly and/or uninteresting commit messages when doing rush change.

@pmconne we started getting pretty lazy with it last year but definitely need to go back to doing it.

@pmconne
Copy link
Member

pmconne commented Jan 6, 2022

@pmconne we started getting pretty lazy with it last year but definitely need to go back to doing it.

Is there a process? Can we edit the compiled changelog files? Inspecting and hand-editing each individual changelog JSON file sounds daunting to say the least...

Copy link
Member

@pmconne pmconne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My preference would be to merge this now and worry about package changelogs in a separate PR.

@calebmshafer
Copy link
Member Author

My preference would be to merge this now and worry about package changelogs in a separate PR.

That's fine by me. It will probably take a few PRs to check them all anyway.

@calebmshafer calebmshafer enabled auto-merge (squash) January 6, 2022 13:22
@calebmshafer
Copy link
Member Author

@grigasp, @pmconne, also FWIW, @skirby1996 is currently going through the awful process of back porting a large set of the patch version changelogs to master to make sure they're up-to-date. So don't try and update anything prior to 3.0 yet.

# Conflicts:
#	docs/changehistory/NextVersion.md
@calebmshafer calebmshafer merged commit fa4c66c into master Jan 6, 2022
@calebmshafer calebmshafer deleted the update-next-version branch January 6, 2022 14:22
pmconne added a commit that referenced this pull request Jan 14, 2022
* Update changelog for 3.0 release (#2854)

* Create a table of contents and re-organize the contents to be more navigable.
* Spelling and formatting fixes
* Consistent casing; fix header level.
* Updates to AppUi change info

* Example with `ParentNode` symbol for root node rule makes no sense
* Promote `getContentInstanceKeys` API to @beta to make it referenceable from docs

Co-authored-by: Paul Connelly <[email protected]>
Co-authored-by: NancyMcCallB <[email protected]>
Co-authored-by: Grigas <[email protected]>

* Web IPC fix (#2996)

* Update roadmap.md (#2989)

Co-authored-by: Matt.Gooding <[email protected]>
Co-authored-by: [email protected] <[email protected]>
Co-authored-by: Grigas <[email protected]>
Co-authored-by: bsteinbk <[email protected]>
Co-authored-by: Caleb Shafer <[email protected]>
Co-authored-by: Keith Bentley <[email protected]>

* Update to latest Rush and pnpm versions (#2990)

* 3.0.0-dev.177

* transformer defer aspect export of deferred elements (#2983)

* prevent trying to export aspects of deferred elements
* configure linter to understand the dot notation escape hatch
* remove callProtected
* remove protection from IModelExportHandler methods to make it less weird and add note about exclusivity of calls

Co-authored-by: Michael Belousov <[email protected]>

* Improve support for transparent textures (#2994)

* Define Pass type.

* Helper functions.

* Use Pass in place of RenderPass.

* Textured surfaces with mixed transparency draw in both passes.

Not producing correct results yet.

* Seems to work.

* api; lint.

* api; lint.

* fix raster text.

* not for classifiers.

* Update early z flags.

* Specify texture transparency for test.

* fix transparent pixel discard for classifiers.

* Fix flickering in TwoWayViewportSync (#3002)

* Swap to use the new imodels clients (#2912)

* Update to use the new imodels client
* Remove the old imodelhub tests

* keep an internal imodelbank-client for testing

* Improve ambient occlusion algorithm in situations where scene depth range is very deep (#3001)

Co-authored-by: Paul Connelly <[email protected]>

* 3.0.0-dev.178

* 3.0.0-dev.179

* 3.0.0-dev.180

* 3.0.0-dev.181

* UI: Fix tree node icon alignment (#2853)

* Bug: MessageBoxIconType.NoSymbol shows Success icon instead of no symbol (#2998)

* Honor "None" and "No Symbol" for MessageBox
components

* Update testing

* extract-api

* Support view-independent decoration graphics (#3007)

* Default camera on for 3d View Creator (#3004)

Co-authored-by: Paul Connelly <[email protected]>

* 3.0.0-dev.182

* Remove @EarlinLutz from CODEOWNERS.md (#3013)

* Create integration tests (full stack tests) for RealityDataSource and RealityDataAccess client. (#2952)

* Create integration tests (full stack tests) for RealityDataSource and RealityDataAccess client.

* Put back package in alphabetical order

* Add changelog

* Revisited the way map layers authentication is handled in the UI. (#3009)

* Revisited the way map layers authentifcation is handled in the UI.

* Added changed log

* Added api files

* Fixed build errors following linting.  Updated changedlog message,

* Created new documentation group for map layers.

* Updated module directives to MapLayers

* Revert adjustZPlanes globe change (#3014)

* Sky cube primitive buffers must be bound when attempting to draw a sky cube.

* Revert adjustZPlanes globe change.

* rush extract-api

* rush change

* changelog unneeded for regression that was never released.

Co-authored-by: Paul Connelly <[email protected]>

* Updating map-layers code owner. (#3020)

* Optimize matrix calculation (#3022)

* optimize matrix calculation

* optimize matrix calculation

* remove vague changelog of no interest to package consumers

Co-authored-by: Paul Connelly <[email protected]>

* lock down itwinui-react version (#3023)

* 3.0.0-dev.183

* Unregister maplayers itemsProvider and widget control on terminate (#3003)

* Unregister maplayers itemsProvider and widget control on termine

* Added changelog.

* Dont register Widget control.

* Fix lint errors.

* Remove the itwin client package (#3021)

* Remove the `@bentley/itwin-client` package
* Roll the request wrappers into packages that need it, including imodelhub client, core-mobile and core-frontend

Co-authored-by: Paul Connelly <[email protected]>

* Fix schedule state synchronization (#3030)

* 2.19.14 - 2.19.28 changelogs (#3031)

* clean up old changelogs (#3029)

* Set correct dist-tag in publish pipeline (#2700)

* Fix bug where new releases of old versions would get 'latest' tag

* delete unused variables

* Update dist tag logic

* Improve logic for giving out 'previous' tag

* Fix bugs and add comments to dist tag script

* Handle empty versions

* 3.0.0-dev.184

* Fix unhandled exception on iOS when exitPointerLock is called. (#3033)

* Presentation: Empty selection set after clear and replace (#3034)

* Add a test to reproduce selection set becoming empty due to unified selection after clearing and replacing selection set

* Fix unified selection tests to wait not only for `unified -> viewport` selection, but also for `viewport -> unified` selection to be synced

* Fix hilite set being cached with wrong guid

* rush change

* [build] Fix the use of the previousVer variable (#3037)

* Replace Viewport.readImage (#3035)

* readImageBuffer.

* Allow absolute viewport position so view rect can be precisely specified in pixels.

* testBlankViewport

* Test proving readImage reads upside-down.

* Test inverted y in view rect.

* Corresponding readImageBuffer tests.

* Implement readImageBuffer; tests pass.

* docs, rename.

* deprecate RenderTarget.readImage too.

* tests

* finish up tests.

* doc.

* NextVersion.md

* fix up callers of readImage.

* update test for correct behavior.

* update a couple more tests.

* extract-api

* doc is lie.

* completely unimportant typo.

* Provide default tool assistance for face/edge/vertex selection phase. (#3036)

* 3.0.0-dev.185

* 3.1.0-dev.0

* @bentley/imodeljs-native 3.1.1

* Update core-mobile API exports and release tags (#2836)

* Update core-mobile release tags

* Simplify RenderMaterial creation. (#3042)

* Simplify RenderMaterial creation.

* move webgl test to webgl dir.

* wip tests.

* wip test

* fix test.

* finish tests.

* docs.

* docs, deprecation

* Lint; NextVersion

* words.

* words words

* extract-api

* unused import.

* 3.1.0-dev.1

* fix presentation-full-stack-tests

Co-authored-by: Caleb Shafer <[email protected]>
Co-authored-by: NancyMcCallB <[email protected]>
Co-authored-by: Grigas <[email protected]>
Co-authored-by: swbsi <[email protected]>
Co-authored-by: Matt.Gooding <[email protected]>
Co-authored-by: [email protected] <[email protected]>
Co-authored-by: bsteinbk <[email protected]>
Co-authored-by: Keith Bentley <[email protected]>
Co-authored-by: imodeljs-admin <[email protected]>
Co-authored-by: Michael Belousov <[email protected]>
Co-authored-by: Michael Belousov <[email protected]>
Co-authored-by: markschlosseratbentley <[email protected]>
Co-authored-by: Robert Lukasonok <[email protected]>
Co-authored-by: kckst8 <[email protected]>
Co-authored-by: MarcBedard8 <[email protected]>
Co-authored-by: Michel D'Astous <[email protected]>
Co-authored-by: MarcNeely <[email protected]>
Co-authored-by: Seamus Kirby <[email protected]>
Co-authored-by: Travis Cobbs <[email protected]>
Co-authored-by: bbastings <[email protected]>
Co-authored-by: GerardasB <[email protected]>
Co-authored-by: Robert Schili <[email protected]>
Co-authored-by: hnn0003 <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Colin Kerr <[email protected]>
Co-authored-by: williamkbentley <[email protected]>
Co-authored-by: affank <[email protected]>
Co-authored-by: Affan Khan <[email protected]>
Co-authored-by: Sam Wilson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants