Skip to content

Commit ec58bac

Browse files
Merge pull request #58 from beamable/merge-core/v7.0-into-unity/v5.0
Merge core/v7.0 into unity/v5.0 (Conflicts)
2 parents 36cb600 + b12e111 commit ec58bac

9 files changed

Lines changed: 19 additions & 21 deletions

File tree

.github/workflows/auto-publish-branch.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ jobs:
3535
id: version
3636
run: |
3737
BRANCH="${{ github.ref_name }}"
38-
38+
3939
# Extract the product prefix (before the first /)
4040
PRODUCT_PREFIX="${BRANCH%%/*}"
41-
41+
4242
# Map branch prefix to product name
4343
case "$PRODUCT_PREFIX" in
4444
unity)
@@ -111,7 +111,7 @@ jobs:
111111
if: steps.check.outputs.published == 'false'
112112
run: echo "Skipping — ${{ steps.version.outputs.mike_alias }} has not been manually published yet."
113113

114-
114+
115115

116116
# Confirm mkdocs.yml is present before attempting a deploy
117117
- name: Verify mkdocs.yml exists
@@ -135,7 +135,7 @@ jobs:
135135
run: mike deploy "${{ steps.version.outputs.mike_alias }}" --branch gh-pages --push
136136

137137
- name: Notify Slack
138-
# if: steps.check.outputs.published == 'true'
138+
# if: steps.check.outputs.published == 'true'
139139
if: false
140140
env:
141141
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_DOCS_CHANNEL_URL }}

.github/workflows/auto-sync-core.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ jobs:
6262
with:
6363
token: ${{ secrets.DOCS_PAT }}
6464
title: "Merge ${{ github.ref_name }} into ${{ matrix.branch }} (Conflicts)"
65-
body: The ${{ github.ref_name }} branch was unable to merge into ${{ matrix.branch }}. Please review the changes.
65+
body: The ${{ github.ref_name }} branch was unable to merge into ${{ matrix.branch }}. Please review the changes.
6666
branch: merge-${{ github.ref_name }}-into-${{ matrix.branch }}
6767
delete-branch: true
6868
base: ${{ matrix.branch }}

docs/cli/guides/configuration.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ mainFolder % dotnet beam config
4242
}
4343
```
4444

45-
However, if the `beam config` command was invoked from the `someOtherFolder` path, you should expect to see an error, because there is no `.beamable` folder within the parent lineage.
45+
However, if the `beam config` command was invoked from the `someOtherFolder` path, you should expect to see an error, because there is no `.beamable` folder within the parent lineage.
4646

4747
```sh
4848
someOtherFolder % dotnet beam config
@@ -79,9 +79,7 @@ The Beamable CLI executes as a local dotnet tool installation. That means that t
7979

8080
!!! info "The folder can exist in a higher folder."
8181

82-
Normally the `.config/` folder exists as a sibling of the `.beamable/` folder. However, the `.config/` folder _may_ exist in a parent folder. The closest `.config/` folder will be used. See the [dotnet tool documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use) for more information.
83-
84-
82+
Normally the `.config/` folder exists as a sibling of the `.beamable/` folder. However, the `.config/` folder _may_ exist in a parent folder. The closest `.config/` folder will be used. See the [dotnet tool documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use) for more information.
8583

8684

8785
## Workspace Overview

docs/cli/guides/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Verify it is installed by running `dotnet --version` from a terminal.
88

99
!!! info "We support Dotnet 8 as well."
1010

11-
If you are using the Beamable CLI before version 7.0, then you should be using [Dotnet 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). Starting with CLI 7.0 and beyond, we support both versions of dotnet, but we recommend you use `net10.0`.
11+
If you are using the Beamable CLI before version 7.0, then you should be using [Dotnet 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). Starting with CLI 7.0 and beyond, we support both versions of dotnet, but we recommend you use `net10.0`.
1212

1313
## Installing
1414
To install the Beamable CLI, run the following command in a shell.

docs/cli/guides/ms-command-line.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ dotnet beam config | jq '.data.cid'
9696
"123"
9797
```
9898

99-
Sometimes it is important to get the unescaped JSON, so the `fromjson` component of JQ can be used. For example, if we wanted the `cid` value, but without quotes,
99+
Sometimes you need the unescaped JSON; the `fromjson` component of JQ can be used. For example, if we wanted the `cid` value, but without quotes,
100100

101101
```sh
102102
dotnet beam config | jq '.data.cid | fromjson'

docs/cli/guides/ms-logging.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,13 @@ Each log has a _level_, or an _importance_ rating. Logs are one of the following
5656
- _Debug_
5757
- _Verbose_
5858

59-
When you run a Microservice locally, you will see log messages at the _Debug_ level and above. However, in a deployed Microservice, you will only see **Information** and above. This is called the _Log Level_. Best practice is to avoid logging _Debug_ and _Verbose_ logs in production, as they negatively impact performance.
59+
When you run a Microservice locally, you will see log messages at the _Debug_ level and above. However, in a deployed Microservice, you will only see **Information** and above. This is called the _Log Level_. Best practice is to avoid logging _Debug_ and _Verbose_ logs in production, as they negatively impact performance.
6060

6161
The `Log` type has methods for each type of log level.
6262

6363
!!! info
6464

65-
The default log level is `DEBUG` when you are running a service locally in development. However, deployed services use the `INFO` level by default.
65+
The default log level is `DEBUG` when you are running a service locally in development. However, deployed services use the `INFO` level by default.
6666

6767
#### Request Dynamic Log Levels
6868

@@ -93,7 +93,7 @@ However, the attribute, `a`, is available for querying in Portal. Use a custom s
9393

9494
#### Scoped Custom Attributes
9595

96-
It is possible to automatically add attributes to an entire sequence of logs. For example, imagine you wanted to tag a series of log lines as being part of an algorithm.
96+
You can automatically add attributes to an entire sequence of logs. For example, imagine you wanted to tag a series of log lines as being part of an algorithm.
9797

9898
```csharp
9999
[ClientCallable]
@@ -214,7 +214,7 @@ There are several standard log attributes that will be included automatically. S
214214

215215
### Third Party Log Hosting
216216

217-
Starting with version 6.0, it is possible to send Microservice logs to a third parties. In this example, we will use BetterStack.
217+
Starting with version 6.0, you can send Microservice logs to third-party log hosting services. In this example, we will use BetterStack.
218218

219219
This section will assume you have set up a BetterStack account, and created a _Source_ such that you have a _source token_ and an _ingesting host_.
220220

docs/cli/guides/ms-routing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ var scope = cid + '.' + pid;
7373
```
7474
#### Authorization
7575

76-
Finally, while not required, it is important to send an HTTP authorization header in the form of a Bearer token. The bearer token should be a valid access token for a Beamable Player. These tokens can be fetched from Portal, or you can use the following command to view the token information from a local beamable CLI project.
76+
Finally, while not required, we recommend sending an HTTP authorization header in the form of a Bearer token. The bearer token should be a valid access token for a Beamable Player. These tokens can be fetched from the Portal, or you can use the following command to view the token information from a local beamable CLI project.
7777

7878
```sh
7979
cat .beamable/temp/auth.beam.json
@@ -132,7 +132,7 @@ The automatic client code generation can be disabled when a project builds by mo
132132

133133
### Open API
134134

135-
It is possible to use the project oapi command to generate an Open API document and then use open source tools to transpile the document into a client in some other programming language.
135+
You can use the project oapi command to generate an Open API document and then use open source tools to transpile the document into a client in some other programming language.
136136

137137
```sh
138138
dotnet beam project oapi --output example.json --ids MyService

docs/cli/guides/ms-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ When a service is stopped this way, you should expect to see a log in the Micros
9191

9292
## Observing Logs
9393

94-
When a service is run, the process that starts the service should receive the log outputs. For example, if the service is run through the IDE, then the IDE should receive the logs from the service. However, it is possible to attach to the logs of a running service from a separate process.
94+
When a service is run, the process that starts the service should receive the log outputs. For example, if the service is run through the IDE, then the IDE should receive the logs from the service. However, you can attach to the logs of a running service from a separate process.
9595

9696
For example, imagine that a service is run through `dotnet` directly,
9797

docs/cli/guides/upgrading.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ generated when the Microservices were built. However, in CLI 5+, the engine inte
134134
are responsible for generating the client code, and the default behaviour is that a standalone
135135
Microservice project will _no longer generate client code automatically_.
136136

137-
It is possible to generate a unity client by hand using the following command,
137+
You can generate a Unity client by hand using the following command,
138138
```sh
139139
dotnet beam project generate-client-oapi --output-dir ./Path/To/Your/Unity/Folder/To/Put/Clients/In
140140
```
@@ -161,8 +161,8 @@ The upgrade from 3.0.x to 4.0.0 is relatively simple compared to other major
161161
releases.
162162

163163
#### Removed `net6.0` and `net7.0` support
164-
Unfortunately, `net6.0` and `net7.0` have reached their [End-Of-Life phases](https://devblogs.microsoft.com/dotnet/dotnet-6-end-of-support/).
165-
The CLI 4.0 release officially drops Beamable support for these EOL .NET versions; when you update your projects, you must update your `.csproj` files to use `net8.0`.
164+
Unfortunately, `net6.0` and `net7.0` have reached their [End-Of-Life phases](https://devblogs.microsoft.com/dotnet/dotnet-6-end-of-support/).
165+
The CLI 4.0 release officially drops Beamable support for these EOL .NET versions; when you update your projects, you must update your `.csproj` files to use `net8.0`.
166166

167167
In all your `.csproj` files, find the line with the `<TargetFramework>`
168168
declaration,

0 commit comments

Comments
 (0)