Skip to content

Commit

Permalink
Remove various master references + fix up some stale docs (#2791)
Browse files Browse the repository at this point in the history
  • Loading branch information
nirinchev authored Feb 4, 2022
1 parent 416c3ab commit 67d83d9
Show file tree
Hide file tree
Showing 17 changed files with 27 additions and 32 deletions.
2 changes: 1 addition & 1 deletion .github/actions/benchmark-uploader/__tests__/main.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ describe("uploadBenchmarkResults", () => {
it.skip("succeeds", async () => {
const apiKey = "%ADD_API_KEY%";
const results = require("./bench-tests.json");
results.Branch = "master";
results.Branch = "main";
results.Commit = "64ad0b0dc8a834a5172681e452e2562d5195f7fd";
results.CommitMessage = "Delete me";
results.RunId = 1006;
Expand Down
4 changes: 2 additions & 2 deletions .github/actions/benchmark-uploader/charts-template.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"exportVersion":4,
"dashboards":{
"dashboard":{
"description":"Benchmark results for the Realm.NET SDK: https://github.com/realm/realm-dotnet/tree/master/Tests/Benchmarks/PerformanceTests",
"description":"Benchmark results for the Realm.NET SDK: https://github.com/realm/realm-dotnet/tree/main/Tests/Benchmarks/PerformanceTests",
"filters":[
{
"type":"String",
Expand All @@ -11,7 +11,7 @@
"settings":{
"allOthers":false,
"values":[
"master"
"main"
]
},
"linkedFields":[
Expand Down
4 changes: 2 additions & 2 deletions .github/actions/benchmark-uploader/dist/charts-template.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions .github/templates/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
name: "CodeQL"
"on":
push:
branches: [ master, main ]
branches: [ main ]
pull_request:
branches: [ master, main ]
branches: [ main ]
env:
REALM_DISABLE_ANALYTICS: true
jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/templates/common.lib.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
#@ actionFindPR = "juliangruber/find-pull-request-action@f9f7484f8237cf8485e5ab826e542ba5dd9e9c6e" #! 1.5.0
#@ actionMergePR = "juliangruber/merge-pull-request-action@8a13f2645ad8b6ada32f829b2fae9c0955a5265d" #! 1.0.6

#@ mainBranch = "master"
#@ mainBranch = "main"

#@ def checkoutCode(submodules=False, registerProblemMatchers=True):
- name: Checkout code
Expand Down
1 change: 0 additions & 1 deletion .github/templates/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,6 @@ name: main
push:
branches:
- main
- master
pull_request:
env:
REALM_DISABLE_ANALYTICS: true
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@ name: CodeQL
"on":
push:
branches:
- master
- main
pull_request:
branches:
- master
- main
env:
REALM_DISABLE_ANALYTICS: true
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ name: main
push:
branches:
- main
- master
pull_request: null
env:
REALM_DISABLE_ANALYTICS: true
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ jobs:
artifacts: Realm/packages/io.realm.unity-${{ steps.get-version.outputs.version }}.tgz/io.realm.unity-${{ steps.get-version.outputs.version }}.tgz
bodyFile: Realm/packages/ExtractedChangelog/ExtractedChangelog.md
name: ${{ steps.get-version.outputs.version }}
commit: master
commit: main
tag: ${{ steps.get-version.outputs.version }}
token: ${{ secrets.GITHUB_TOKEN }}
draft: false
Expand Down Expand Up @@ -97,7 +97,7 @@ jobs:
title: Prepare for vNext
body: Update Changelog for vNext
delete-branch: true
base: master
base: main
commit-message: Prepare for vNext
- name: Merge Pull Request
uses: juliangruber/merge-pull-request-action@8a13f2645ad8b6ada32f829b2fae9c0955a5265d
Expand Down
5 changes: 2 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ equal.
didAdd = obj.UniqueStrings.Add("foo"); // false
```
* Added support for value substitution in string based queries. This enables expressions following
[this syntax](https://github.com/realm/realm-js/blob/master/docs/tutorials/query-language.md): `realm.All<T>().Filter("field1 = $0 && field2 = $1", 123, "some-string-value")`.
[this syntax](https://docs.mongodb.com/realm/reference/realm-query-language/): `realm.All<T>().Filter("field1 = $0 && field2 = $1", 123, "some-string-value")`.
(Issue [#1822](https://github.com/realm/realm-dotnet/issues/1822))
* Reduced the size of the native binaries by ~5%. (PR [#2239](https://github.com/realm/realm-dotnet/pull/2239))
* Added a new class - `Logger`, which allows you to override the default logger implementation (previously writing to `stdout` or `stderr`) with a custom one by setting
Expand Down Expand Up @@ -1076,8 +1076,7 @@ scenarios such as:
- Distinct: `realm.All<Dog>().Filter("TRUEPREDICATE DISTINCT(Age) SORT(Name)")` - find all dogs, sort them
by their name and pick one dog for each age value.
- For more examples, check out the
[javascript query language docs](https://github.com/realm/realm-js/blob/master/docs/tutorials/query-language.md) -
the query syntax is identical - or the [NSPredicate Cheatsheet](https://academy.realm.io/posts/nspredicate-cheatsheet/).
[query language reference docs](https://docs.mongodb.com/realm/reference/realm-query-language/) or the [NSPredicate Cheatsheet](https://academy.realm.io/posts/nspredicate-cheatsheet/).
- The `SyncConfiguration` constructor now accepts relative Uris. ([#1720](https://github.com/realm/realm-dotnet/pull/1720))
- Added the following methods for resetting the user's password and confirming their email:
`RequestPasswordResetAsync`, `CompletePasswordResetAsync`, `RequestEmailConfirmationAsync`, and `ConfirmEmailAsync`.
Expand Down
2 changes: 1 addition & 1 deletion Docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"_appFooter": "Copyright © 2020 <a href=\"https://realm.io\">Realm</a><br>Generated by <strong>DocFX</strong>",
"_gitContribute": {
"repo": "https://github.com/realm/realm-dotnet.git",
"branch": "master",
"branch": "main",
"path": "Docs/apispec"
}
},
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Realm](https://github.com/realm/realm-dotnet/raw/master/logo.png)
![Realm](https://github.com/realm/realm-dotnet/raw/main/logo.png)

Realm is a mobile database that runs directly on phones, tablets or wearables.

Expand Down Expand Up @@ -29,7 +29,7 @@ The API reference is located at [docs.mongodb.com/realm-sdks/dotnet/latest/](htt
## Nightly builds

If you want to test recent bugfixes or features that have not been packaged in an official release yet, you can use the preview releases published after every
commit to our private NuGet feed. The source URL you need to specify for our feed is `https://s3.amazonaws.com/realm.nugetpackages/index.json`.
commit to our private NuGet feed. The source URL you need to specify for our feed is `https://s3.amazonaws.com/realm.nugetpackages/index.json`.
Refer to [this guide](https://www.visualstudio.com/en-us/docs/package/nuget/consume) for instructions on adding custom sources to the NuGet Package Manager.

## Building Realm
Expand All @@ -56,7 +56,7 @@ Some minimal examples of Realm use can be found in the `examples` folder:

* [QuickJournal](examples/QuickJournal): a simple Xamarin.Forms application that shows how Realm can be used effectively in conjunction with MVVM and data binding.

## Contributing
## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for more details!

Expand Down
2 changes: 1 addition & 1 deletion Realm/Realm.Fody/Realm.Fody.xcf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:attribute name="DisableAnalytics" type="xs:boolean">
<xs:annotation>
<xs:documentation>Disables anonymized usage information from being sent on build. Read more about what data is being collected and why here: https://github.com/realm/realm-dotnet/blob/master/Realm/Realm.Fody/Common/Analytics.cs</xs:documentation>
<xs:documentation>Disables anonymized usage information from being sent on build. Read more about what data is being collected and why here: https://github.com/realm/realm-dotnet/blob/main/Realm/Realm.Fody/Common/Analytics.cs</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
2 changes: 1 addition & 1 deletion Realm/Realm.Unity/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Realm](https://github.com/realm/realm-dotnet/raw/master/logo.png)
![Realm](https://github.com/realm/realm-dotnet/raw/main/logo.png)

Realm is an embedded mobile database that runs directly on phones, tablets, or desktops.

Expand Down
6 changes: 3 additions & 3 deletions Realm/Realm/Extensions/CollectionExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ public static IDisposable SubscribeForKeyNotifications<T>(this IDictionary<strin
/// var results4 = realm.All&lt;Foo&gt;("Bar.IntValue > $0 || (Bar.String == $1 &amp;&amp; Bar.Bool == $2)", 5, "small", true);
/// </code>
/// </example>
/// <seealso href="https://github.com/realm/realm-js/blob/master/docs/tutorials/query-language.md">
/// <seealso href="https://docs.mongodb.com/realm/reference/realm-query-language/">
/// Examples of the NSPredicate syntax
/// </seealso>
/// <seealso href="https://academy.realm.io/posts/nspredicate-cheatsheet/">NSPredicate Cheatsheet</seealso>
Expand Down Expand Up @@ -365,7 +365,7 @@ public static IQueryable<T> Filter<T>(this IQueryable<T> query, string predicate
/// joe.dogs.Filter("Name BEGINSWITH $0", "R");
/// </code>
/// </example>
/// <seealso href="https://github.com/realm/realm-js/blob/master/docs/tutorials/query-language.md">
/// <seealso href="https://docs.mongodb.com/realm/reference/realm-query-language/">
/// Examples of the NSPredicate syntax
/// </seealso>
/// <seealso href="https://academy.realm.io/posts/nspredicate-cheatsheet/">NSPredicate Cheatsheet</seealso>
Expand Down Expand Up @@ -402,7 +402,7 @@ public static IQueryable<T> Filter<T>(this IList<T> list, string predicate, para
/// joe.dogs.Filter("Name BEGINSWITH $0", "R");
/// </code>
/// </example>
/// <seealso href="https://github.com/realm/realm-js/blob/master/docs/tutorials/query-language.md">
/// <seealso href="https://docs.mongodb.com/realm/reference/realm-query-language/">
/// Examples of the NSPredicate syntax
/// </seealso>
/// <seealso href="https://academy.realm.io/posts/nspredicate-cheatsheet/">NSPredicate Cheatsheet</seealso>
Expand Down
2 changes: 1 addition & 1 deletion Tests/Benchmarks/PerformanceTests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The .NET Performance project has an [amazing guide](https://github.com/dotnet/pe

## Historical performance

Benchmarks are run as part of merge commits to master and then uploaded to MongoDB Atlas (see [#2552](https://github.com/realm/realm-dotnet/pull/2552) for details) and then plotted using MongoDB Charts. A dashboard with benchmark runs can be found [here](https://charts.mongodb.com/charts-realm-sdk-metrics-yxjvt/public/dashboards/6115babd-c7fe-47ee-836f-efffd92ffae3).
Benchmarks are run as part of merge commits to main and then uploaded to MongoDB Atlas (see [#2552](https://github.com/realm/realm-dotnet/pull/2552) for details) and then plotted using MongoDB Charts. A dashboard with benchmark runs can be found [here](https://charts.mongodb.com/charts-realm-sdk-metrics-yxjvt/public/dashboards/6115babd-c7fe-47ee-836f-efffd92ffae3).

### Adding new benchmarks

Expand Down
10 changes: 5 additions & 5 deletions wrappers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ If you cloned your `realm-dotnet` repository, you can use a git command to get t

### Direct Download

If you downloaded a zip of the source, you need to go back to github to identify which version of Objectstore is required. There is no git information in the zip file which specifies this.
If you downloaded a zip of the source, you need to go back to github to identify which version of Core is required. There is no git information in the zip file which specifies this.

1. Look in the github repo [wrappers](https://github.com/realm/realm-dotnet/tree/master/wrappers) and you will see the link to the submodule, eg: `realm-core @ 802aa43`.
1. Click the link to take you to the tree in ObjectStore
1. Download a zip using the GitHub download button in that tree, eg `realm-object-store-fb2ed6aa0073be4cb0cd059cae407744ee883b77.zip`
1. Unpack its contents into `wrappers/src/object-store`
1. Look in the github repo [wrappers](https://github.com/realm/realm-dotnet/tree/main/wrappers) and you will see the link to the submodule, eg: `realm-core @ 802aa43`.
1. Click the link to take you to the tree in Core
1. Download a zip using the GitHub download button in that tree, eg `realm-core-fb2ed6aa0073be4cb0cd059cae407744ee883b77.zip`
1. Unpack its contents into `wrappers/src/realm-core`

Building iOS wrappers on macOS
------------------------------------------
Expand Down

0 comments on commit 67d83d9

Please sign in to comment.