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 release docs #11351

Merged
merged 5 commits into from
Mar 11, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
2 changes: 1 addition & 1 deletion src/OrchardCore.Build/OrchardCore.Commons.props
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<Import Project="Dependencies.props" />

<PropertyGroup>
<VersionPrefix>1.3.0</VersionPrefix>
<VersionPrefix>1.4.0</VersionPrefix>
<VersionSuffix>preview</VersionSuffix>
<VersionSuffix Condition="'$(VersionSuffix)'!='' AND '$(BuildNumber)' != ''">$(VersionSuffix)-$(BuildNumber)</VersionSuffix>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
Expand Down
5 changes: 4 additions & 1 deletion src/docs/getting-started/templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,11 @@ dotnet new -i OrchardCore.ProjectTemplates::1.3.0-* --nuget-source https://nuget

#### Generate an Orchard Cms Web Application

!!! warning
Due to a bug in the current published version, the following `dotnet new` commands will require the extra argument `--orchard-version 1.3.0`. For instance, instead of typing `dotnet new occms` use `dotnet new occms --orchard-version 1.3.0`
Piedone marked this conversation as resolved.
Show resolved Hide resolved

```CMD
dotnet new occms
dotnet new occms
```

The above command will use the default options.
Expand Down
21 changes: 13 additions & 8 deletions src/docs/topics/publishing-releases/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ Do some housekeeping on GitHub in the [main repo](https://github.com/OrchardCMS/

Update the source so everything looks like on the new version.

- [ ] Create a `release/<version name>` branch out of `main`.
- [ ] Update code generation templates in `OrchardCore.ProjectTemplates`.
- [ ] Update the `OrchardCore.Commons.props` file: Update `VersionPrefix` for release versions (like "1.0.0") and `VersionSuffix` for pre-release versions (like "rc2", for the full version to be e.g. "1.0.0-rc2").
- [ ] Update module versions in `ManifestConstants`.
- [ ] Create a `release/<version name>` branch out of `main`, e.g. `release/1.3.1`.
- [ ] Update the `OrchardCore.Commons.props` file with `<VersionSuffix></VersionSuffix>` such that preview build numbers are not injected in packages. Verify the `VersionPrefix` tag matches the released version.
- [ ] Update module versions in `src/OrchardCore/OrchardCore.Abstractions/Modules/Manifest/ManifestConstants.cs`.

### Test the release

Expand All @@ -51,20 +50,20 @@ Update everything in the [Translations project](https://github.com/OrchardCMS/Or

Update the docs so they contain information about the new release so once the release is out you'll just need to point to new information.

- [ ] Create a new __Draft__ Release with a tag `vx.y.z` that is created when the release is published. Auto-generate release notes.
Copy link
Member

Choose a reason for hiding this comment

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

Link this from the doc page explained below?

- [ ] Create release notes in a specific documentation section. You can take the previous release notes as a template.
- Overview of the release's highlights and goals. What do you want people to remember this release for?
- Prerequisites. What framework version do you need, anything else to work with Orchard?
- Upgrade steps, any migration necessary from previous versions, breaking changes.
- Full changelog. You can generate this with [github-changelog](https://github.com/cfpb/github-changelog) with the `changelog OrchardCMS OrchardCore <previous version> <current version>` command, e.g. `changelog OrchardCMS OrchardCore 1.0.0-rc1 1.0.0-rc2`. Alternatively, you can use [Antoine's app](https://github.com/agriffard/Changelog.OrchardCore) too.

### Publish the release

Do the harder parts of making the release public. This should come after everything above is done.

- [ ] Merge `release/<version name>` to `master`.
- Merges to `master` need two approvals so you'll need to create a pull request.
- [ ] Merge `release/<version name>` to `main`.
- Merges to `main` need two approvals so you'll need to create a pull request.
- Merge it as a merge commit, not squash merge.
- [ ] Tag `master` with the full version name, including the prefix and suffix (e.g. "1.0.0-rc2").
- [ ] Publish the Draft release.
- [ ] Test the [guides](https://docs.orchardcore.net/en/latest/docs/guides/) with the packages now automatically published to NuGet. Test at least the following guides:
- [Creating a modular ASP.NET Core application](https://docs.orchardcore.net/en/dev/docs/guides/create-modular-application-mvc/)
- [Creating an Orchard Core CMS website](https://docs.orchardcore.net/en/dev/docs/guides/create-cms-application/)
Expand All @@ -81,4 +80,10 @@ Let the whole world know about our shiny new release. Savor this part! These ste
- [ ] Ask to publish a blog post on [DevBlogs](https://devblogs.microsoft.com/).
- [ ] Ask to publish a blog post on [.NET Foundation News](https://dotnetfoundation.org/news).
- [ ] Tweet

### After the release is done

- [ ] Create a new milestone with the next release number.
- [ ] Update the `OrchardCore.Commons.props` file with the next release number, and `<VersionSuffix>preview</VersionSuffix>` such that preview builds use the new one.

```