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.

Sign up for GitHub

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

Deprecate ISummaryAuthor and ISummaryCommitter #10932

Merged
merged 7 commits into from
Jul 1, 2022
Merged

Deprecate ISummaryAuthor and ISummaryCommitter #10932

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
531456e
deprecate ISummaryAuthor and ISummaryCommitter
ghoshkaj Jun 30, 2022
117186c
commit updated docs
ghoshkaj Jul 1, 2022
bc6a43e
Update BREAKING.md
ghoshkaj Jul 1, 2022
9838232
remove dashes
ghoshkaj Jul 1, 2022
76ed757
change BREAKING.MD comment
ghoshkaj Jul 1, 2022
4b97726
pesky space
ghoshkaj Jul 1, 2022
0518542
modify comments
ghoshkaj Jul 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions BREAKING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,15 @@ There are a few steps you can take to write a good change note and avoid needing

## 1.1.0 Upcoming changes
- [IContainerRuntime.createRootDataStore is deprecated](#icontainerruntimecreaterootdatastore-is-deprecated)
- [ ISummaryAuthor and ISummaryCommitter are deprecated](#isummaryauthor-and-isummarycommitter-are-deprecated)

### IContainerRuntime.createRootDataStore is deprecated
See [#9660](https://github.com/microsoft/FluidFramework/issues/9660). The API is vulnerable to name conflicts, which lead to invalid documents. As a replacement, create a regular datastore using the `IContainerRuntimeBase.createDataStore` function, then alias the datastore by using the `IDataStore.trySetAlias` function and specify a string value to serve as the alias to which the datastore needs to be bound. If successful, "Success" will be returned, and a call to `getRootDataStore` with the alias as parameter will return the same datastore.

### ISummaryAuthor and ISummaryCommitter are deprecated
See [#10456](https://github.com/microsoft/FluidFramework/issues/10456). `ISummaryAuthor` and `ISummaryCommitter`
are deprecated and will be removed in a future release.

# 1.0.0

## 1.0.0 Upcoming changes
Expand Down
4 changes: 2 additions & 2 deletions common/lib/protocol-definitions/api-report/protocol-definitions.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ export interface ISummaryAttachment {
type: SummaryType.Attachment;
}

// @public (undocumented)
// @public @deprecated (undocumented)
export interface ISummaryAuthor {
// (undocumented)
date: string;
Expand All @@ -434,7 +434,7 @@ export interface ISummaryBlob {
type: SummaryType.Blob;
}

// @public (undocumented)
// @public @deprecated (undocumented)
export interface ISummaryCommitter {
// (undocumented)
date: string;
Expand Down
6 changes: 6 additions & 0 deletions common/lib/protocol-definitions/src/summary.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,19 @@ export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISumm

export type SummaryTree = ISummaryTree | ISummaryHandle;

/**
* @deprecated ISummaryAuthor is deprecated and will be removed in a future release.
*/
export interface ISummaryAuthor {
name: string;
email: string;
// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
date: string;
}

/**
* @deprecated ISummaryCommitter is deprecated and will be removed in a future release.
*/
export interface ISummaryCommitter {
name: string;
email: string;
Expand Down