You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Identify Pull Requests: Review any pull requests (PRs) that need to be backported to the release branch.
Backporting Process: For PRs merged into the main branch that need to be applied to the release branch (e.g., release/2.1), comment on the merged PR with /backport to release/2.1. This comment will trigger a GitHub Action to create a new PR with the same changes for the release/2.1 branch.
Merge PRs: Once all necessary PRs are created, merge them into the release/2.1 branch.
Step 2: Code and Documentation Updates
Create Pull Request:
From the release branch (e.g., release/2.1), create a new temporary branch for your release (e.g., release-notes/2.1.1).
Update version references in the documentation. Refer to this PR for an example. Version Updates Checklist:
Update OrchardCore.Commons.props: Set <VersionSuffix></VersionSuffix> to the new version you're preparing for release.
Update Module Versions: Modify src/OrchardCore/OrchardCore.Abstractions/Modules/Manifest/ManifestConstants.cs to reflect the new version.
Release Notes: Finalize the release notes in the documentation, including:
Highlights and goals of the release.
Prerequisites for running the new version.
Upgrade steps and any breaking changes.
Update Documentation Navigation: Add the release notes page to mkdocs.yml navigation and remove it from not_in_nav.
Version Mentions: Update all references to the new version throughout the documentation, including:
Create a Documentation PR PR titled "Release with the new version number" (e.g., Release 2.1.1) from the documentation branch (e.g., release-notes/2.1.1) into the release branch (e.g., release/2.1)
Merge the Documentation PR.
In GitHub, manually run the Preview - CI workflow on your branch (NOT main). This will release a new preview version on CloudSmith for testing.
Step 3: Validation
Check Functionality: Update OrchardCore.Samples to the latest preview version generated in the previous step. Ensure the samples work as expected.
Test Guides: Test the following guides with NuGet packages from the CloudSmith feed:
In the "Choose a tag" menu, enter the new version number, including v (e.g., v2.1.1), and select "+ Create tag: v... on publish."
Change the target branch from main to your target branch (e.g., release/2.1).
Enter the version number in the Title field (e.g., 2.1.1).
Click Generate release notes to auto-generate release notes.
Ensure the "Set as the latest release" checkbox is checked, then click Publish release.
Step 5: Align Branches
Merge to Main: After releasing the new version, merge the release branch into the main branch to ensure main contains all administrative changes.
Create a pull request from the release branch into main.
Important: DO NOT resolve conflicts using GitHub's interface; use external tools (e.g., Fork) to manage conflicts and avoid auto-merging main into the release branch. Resolving conflicts using GitHub's interface will automatically merge main into the release branch, which must be avoided.
Once conflicts are resolved, merge the PR into main using the following steps:
Fetch the latest changes from the Git repository.
Checkout the main branch.
Merge the release branch (e.g., release/2.1) into main.
Resolve any conflicts.
Force push the changes to main. This action requires a user with the ability to force-push into main, as it is protected by default.
Step 6: Housekeeping
Assign the milestone for the release version to this issue.
Close any remaining issues for this version or assign them to the next release.
Step 7: Publicize the Release
Post about the release on X (formerly Twitter) via the Orchard Core X (Twitter) repo.
Release Patch Preparation Guide
Step 1: Backporting Pull Requests
main
branch that need to be applied to the release branch (e.g.,release/2.1
), comment on the merged PR with/backport to release/2.1
. This comment will trigger a GitHub Action to create a new PR with the same changes for therelease/2.1
branch.release/2.1
branch.Step 2: Code and Documentation Updates
Create Pull Request:
release/2.1
), create a new temporary branch for your release (e.g.,release-notes/2.1.1
).OrchardCore.Commons.props
: Set<VersionSuffix></VersionSuffix>
to the new version you're preparing for release.src/OrchardCore/OrchardCore.Abstractions/Modules/Manifest/ManifestConstants.cs
to reflect the new version.mkdocs.yml
navigation and remove it fromnot_in_nav
.Release 2.1.1
) from the documentation branch (e.g.,release-notes/2.1.1
) into the release branch (e.g.,release/2.1
)Preview - CI
workflow on your branch (NOTmain
). This will release a new preview version on CloudSmith for testing.Step 3: Validation
OrchardCore.Samples
to the latest preview version generated in the previous step. Ensure the samples work as expected.Step 4: Create New Release
v
(e.g.,v2.1.1
), and select "+ Create tag: v... on publish."main
to your target branch (e.g.,release/2.1
).2.1.1
).Step 5: Align Branches
main
contains all administrative changes.main
.main
into the release branch. Resolving conflicts using GitHub's interface will automatically mergemain
into the release branch, which must be avoided.main
using the following steps:main
branch.release/2.1
) intomain
.main
. This action requires a user with the ability to force-push intomain
, as it is protected by default.Step 6: Housekeeping
Step 7: Publicize the Release
The text was updated successfully, but these errors were encountered: