Orchardcore: Release 1.0

Created on 4 Oct 2020 · 9Comments · Source: OrchardCMS/OrchardCore

Prepare the project

Do some housekeeping on GitHub in the main repo.

[ ] Close remaining issues for the version (including merging corresponding pull requests if suitable) or assign then to the next one.
[ ] Assign all issues that were closed for an upcoming version (including a wildcard version like "1.0.x") to this version (milestone).

Prepare the code

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

[X] Create a release/<version name> branch out of dev. See #7236
[X] Update code generation templates in OrchardCore.ProjectTemplates.
[X] 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").
[X] Update module versions in ManifestConstants.
[X] Change docker version in _.travis.yml_ and _appveyor.yml_.

Test the release

Make sure everything works all right.

[ ] Make sure that OrchardCore.Samples works.
[ ] Test the guides with the NuGet packages from the Cloudsmith feed (branches under release/ are automatically published too). Test at least the following guides:

Prepare and publish Orchard Core Translations

Update everything in the Translations project. Only do this once all the code changes are done since localized strings can change until then.

[x] Update packageVersion and/or versionPrefix in _appveyor.yml_.
[ ] Nuget package properties: https://github.com/OrchardCMS/OrchardCore.Translations/issues/61
[ ] Update .po files with PoExtractor. This will also update Crowdin.
[ ] Publish the new version on NuGet.
[ ] Update the OrchardCore.Translations.All package reference in the main repo's _src/OrchardCore.Build/Dependencies.props_ file to refer to the new NuGet package.

Prepare the documentation

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 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 with the changelog OrchardCMS OrchardCore <previous version> <current version> command, e.g. changelog OrchardCMS OrchardCore 1.0.0-rc2 1.0.0. Alternatively, you can use Antoine's app 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 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").
[ ] Test the guides with the packages now automatically published to NuGet. Test at least the following guides:
[ ] Update Try Orchard Core.

Publicize the release

Let the whole world know about our shiny new release. Savor this part! These steps will make the release public so only do them once everything else is ready.

[ ] Update the documentation to mention the version in all places where the latest version is referenced, for example, but not limited to (do a search for the package version string): Status in the root README, CLI templates, commands, the Creating a new decoupled CMS Website guide.
[ ] Update the tagged release on GitHub: Change its title to something more descriptive (e.g. "Orchard Core 1.0.0"), add a link in its description to the release notes in the documentation (something like For details on this version see the [release notes in the documentation](link here).). Add a link to this release under Status in the root README.
[ ] Publish a blog post on the website.
[ ] Ask to publish a blog post on DevBlogs.
[ ] Ask to publish a blog post on .NET Foundation News.
[ ] Tweet

Source

agriffard

👍7 🎉6

Most helpful comment

I think we should ship a version on 3.1 because it's LTS (@Skrypt reminded us) and later another one with 5.0. Some users might care about relying on a dotnet version that will be supported for a long time.

sebastienros on 8 Oct 2020

👍5

All 9 comments

We all know it always takes a long time between the moment we decide a Release and the actual Release itself.
RC 2 was a good rehearsal to define the Release steps so lets make this 1.0 a great milestone.

Preliminary steps:

Please comment about the current pull requests that should be included according to you.
Check the issues assigned to milestone 1.0 and tell us if you can contribute: https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aopen+is%3Aissue+milestone%3A1.0

It is yet the best time to make changes that bring breaking changes.
After the Release of 1.0, it will be a bit more difficult.

At some point, I think we will then have to "stop" merging new PRs (that are not necessary or fixing issues) until the release is done.

agriffard on 4 Oct 2020

I know that we ask a lot from the core contributors and that reviewing others's PRs is a tough work and responsability.
If your are not comfortable with the process, please ask for help on specific issues.

People are not always aware of all the time it requires to do all this tasks but you can be sure that is really appreciated and that is one of the most valuable contributions to the project.

Thank you everyone for your work.

agriffard on 4 Oct 2020

Thanks @agriffard for starting this, regarding to me I can assist in the translations part, just few notes:

We can focus on the 1.0.0 issues
Avoid working on new features, because this happen always of course this will defer the release coz every new features needs a design, review ... etc, so let us focus on 1.0.0 issues
Could we assign the remaining issues for the core members - without pressure - and it is free for the community to pick one of those, I know most of us are busy, but we can do balancing here and let the dev picks the one who interested in, instead of wasting the time for other things, unless it's urgent
Try to look for the old PRs, there are 99 PRs at the time of writing this

Hope to hear the feedback from others, thanks

hishamco on 4 Oct 2020

Is OC 1.0.0 targeting .NET 5?

ns8482e on 5 Oct 2020

Is OC 1.0.0 targeting .NET 5?

I think that makes sense.

deanmarcussen on 5 Oct 2020

sebastienros on 8 Oct 2020

👍5

I'm still learning Orchard Core but I would like to help with the development. Are there any issues for release 1 that would be good for someone new to start with? I saw 1 labeled "good first issue" but it looked like it was already being worked on.

DrewBrasher on 16 Oct 2020

I'm still learning Orchard Core but I would like to help with the development. Are there any issues for release 1 that would be good for someone new to start with? I saw 1 labeled "good first issue" but it looked like it was already being worked on.

Check the issues assigned to the 1.0 milestone: https://github.com/OrchardCMS/OrchardCore/issues?q=is%3Aopen+is%3Aissue+milestone%3A1.0