Skip to content

Commit f0afd37

Browse files
Merge pull request #3 from JakeLegendXIII/feature/migration-missing-uninstallation-text
Add 3.8.0 to 3.8.1 dotnet tools uninstallation info
2 parents e55adfb + 3845933 commit f0afd37

File tree

3 files changed

+33
-15
lines changed

3 files changed

+33
-15
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@ on:
33
push:
44
branches:
55
- 'main'
6-
pull_request:
7-
branches:
8-
- 'main'
6+
97
workflow_dispatch:
108

119
permissions:

articles/migrate_38.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@ Migrating from 3.8.0 should be straightforward for most platforms.
99

1010
The major difference is that 3.8.1 now requires .NET 6 and Visual Studio 2022. You can follow the [environment setup tutorial](getting_started/index.md) to make sure that you are not missing any components.
1111

12-
The MGCB Editor is no longer a global .NET tool and we recommend that you use the new Visual Studio 2022 extension which helps accessing it without the need of CLI commands.
12+
The MGCB Editor is no longer a global .NET tool and we recommend that you use the new Visual Studio 2022 extension which helps with accessing it without the need of CLI commands.
13+
14+
15+
::: note
16+
It is also recommended that you uninstall the older global versions of the .NET tools as described below.
17+
:::
1318

1419
## WindowsDX, DesktopGL, and UWP
1520

@@ -30,41 +35,54 @@ Then edit your MonoGame ```PackageReference``` to point to 3.8.1:
3035

3136
### Accessing MGCB and MCGB Editor without a global tool
3237

33-
MGCB Editor is no longer a .NET global tool, and doesn't need to be installed or registered.
38+
The MGCB Editor is no longer a .NET global tool, and does not need to be installed or registered. When migrating from 3.8.0, it is recommended that you **uninstall** the global versions of the tools. You can accomplish that with these commands:
39+
40+
```
41+
dotnet tool uninstall dotnet-mgcb -g
42+
dotnet tool uninstall dotnet-2mgfx -g
43+
dotnet tool uninstall dotnet-mgcb-editor -g
44+
```
45+
46+
::: tip
47+
**Do not** run the ``` dotnet tool install ``` on 3.8.1, as it would break 3.8.1.
48+
:::
49+
50+
You will also need to setup a dotnet-tools configuration file.
3451

35-
However, if you are migrating from 3.8.0, you will need to setup a configuration file. Next to your ```.csproj```, create a folder nammed ```.config``` and a file within it nammed ```dotnet-tools.json``` with this content:
52+
- Next to your ```.csproj```create a folder named ```.config```
53+
- Add a file within the folder named ```dotnet-tools.json``` with the following content:
3654

3755
```json
3856
{
3957
"version": 1,
4058
"isRoot": true,
4159
"tools": {
4260
"dotnet-mgcb": {
43-
"version": "3.8.1.263",
61+
"version": "3.8.1.303",
4462
"commands": [
4563
"mgcb"
4664
]
4765
},
4866
"dotnet-mgcb-editor": {
49-
"version": "3.8.1.263",
67+
"version": "3.8.1.303",
5068
"commands": [
5169
"mgcb-editor"
5270
]
5371
},
5472
"dotnet-mgcb-editor-linux": {
55-
"version": "3.8.1.263",
73+
"version": "3.8.1.303",
5674
"commands": [
5775
"mgcb-editor-linux"
5876
]
5977
},
6078
"dotnet-mgcb-editor-windows": {
61-
"version": "3.8.1.263",
79+
"version": "3.8.1.303",
6280
"commands": [
6381
"mgcb-editor-windows"
6482
]
6583
},
6684
"dotnet-mgcb-editor-mac": {
67-
"version": "3.8.1.263",
85+
"version": "3.8.1.303",
6886
"commands": [
6987
"mgcb-editor-mac"
7088
]
@@ -73,7 +91,7 @@ However, if you are migrating from 3.8.0, you will need to setup a configuration
7391
}
7492
```
7593

76-
Please note that you can't use the ```3.8.1.*``` wildcard in the ```dotnet-tools.json``` file (tool versions have to be fully qualified). We strongly recommand that the versions match the MonoGame version referenced in your ```.csproj``` (if you're using the ```*``` wildcard, make sure that they don't end up mismatching if the nugets are updated without you noticing).
94+
Please note that you cannot use the ```3.8.1.*``` wildcard in the ```dotnet-tools.json``` file (tool versions have to be fully qualified). We strongly recommand that the versions match the MonoGame version referenced in your ```.csproj``` (if you are using the ```*``` wildcard, make sure that they do not end up mismatching if the nugets are updated without you noticing).
7795

7896
You will also need to add this to your ```.csproj```:
7997

articles/whats_new.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: What's New
3-
description: What's new with the release of MonoGame 3.8.1
2+
title: Whats New
3+
description: Whats new with the release of MonoGame 3.8.1
44
---
55

6-
# What's New
6+
# Whats New
77

88
The MonoGame 3.8.1 release marks some big changes since 3.8.0 in how we build and distribute.
99

@@ -20,6 +20,8 @@ MonoGame 3.8.1 now comes with an optional Visual Studio extension which will ins
2020

2121
This extension is available for Visual Studio 2022, and Visual Studio 2022 for Mac.
2222

23+
If you are migrating from 3.8.0 it is recommended to uninstall the existing global MGCB .NET tools. It would be a good idea to review the [Migrating from 3.8.0](migrate_38.md) documentation, as there are changes to how 3.8.1 works with the .NET tools and the new extension.
24+
2325
## Visual Studio 2019 and prior are no longer supported
2426

2527
Since .NET 6 is not supported by Visual Studio 2019, starting with MonoGame 3.8.1 it will no longer be possible to build games with it.

0 commit comments

Comments
 (0)