Skip to content

Commit

Permalink
upmerge v0.36->edge
Browse files Browse the repository at this point in the history
Signed-off-by: Vishwanath Hiremath <[email protected]>
  • Loading branch information
vishwahiremat committed Aug 16, 2024
2 parents 139622f + 3f751f6 commit 81211b0
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 12 deletions.
3 changes: 2 additions & 1 deletion .github/config/en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1268,4 +1268,5 @@ bicepconfig
Bicepconfig
postgres
ReadOnly
DeployTimeConstant
DeployTimeConstant
postgres
56 changes: 50 additions & 6 deletions .github/workflows/upmerge.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# This workflow automates the process of upmerging changes from the current release branch to the edge branch.
# During the course of a release, the release branch is the default branch so that PRs can be immediately
# brought into the release without waiting for a new release. This workflow merges those changes into
# the edge branch so that edge can be used as the basis for the next release branch.
#
# This workflow assumes that it is being triggered from the current release branch, but it could be triggered from
# any branch, and it uses that branch as the source branch for merging into the edge branch.
# The workflow is triggered manually via the workflow_dispatch event.
#
# The workflow performs the following steps:
# 1. Checks out the edge branch.
# 2. Configures git with a user name and email.
# 3. Creates a new branch from edge.
# 4. Merges changes from the branch executing the workflow into the edge branch created in the previous step.
# 5. Pushes the new branch if there are changes.
# 6. Creates a pull request to merge the new branch into edge.

# Example:
# The current release branch is v0.36. We are creating the new release for v0.37.
# The release person manually triggers this workflow from branch v0.36. The workflow runs, which does the following
# 1. A new branch is created named upmerge/2024-07-31-98b9. The source branch is edge.
# 2. Changes from branch v0.36 are merged into branch upmerge/2024-07-31-98b9.
# 3. A PR is created from branch upmerge/2024-07-31-98b9 --> edge. The workflow finishes and reports success.

name: Upmerge docs to edge

on:
Expand All @@ -8,31 +32,51 @@ jobs:
name: Upmerge docs to edge
runs-on: ubuntu-latest
steps:

# Checkout the edge branch
- uses: actions/checkout@v4
with:
ref: edge
# https://github.com/actions/checkout/issues/125#issuecomment-570254411
fetch-depth: 0

- name: Configure git
run: |
git config --global user.email "[email protected]"
git config --global user.name "Radius CI Bot"
# Create a new branch from edge. This branch will be used to PR back into edge.
- name: Create new branch
run: |
export DATE=$(date +%Y-%m-%d)
export RAND=$(openssl rand -hex 2)
echo "BRANCH_NAME=upmerge/$DATE-$RAND" >> $GITHUB_ENV
git checkout -b upmerge/$DATE-$RAND
export BRANCH_NAME=upmerge/$DATE-$RAND
echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV
git checkout -b $BRANCH_NAME
# Merge changes from the github.ref branch, i.e., the branch from which the workflow is triggered. That
# branch is assumed to be the current release branch, but could be any branch.
# If there are no changes, stop the workflow.
- name: Upmerge docs
run: |
export SOURCE_BRANCH=$(basename ${{ github.ref }})
echo "Upmerging docs from $SOURCE_BRANCH to edge"
git fetch origin $SOURCE_BRANCH
git merge --no-commit origin/$SOURCE_BRANCH
git reset HEAD docs/config.toml docs/layouts/partials/hooks/body-end.html
git commit -m "Upmerge to edge"
git push --set-upstream origin $BRANCH_NAME
git merge -m "Upmerge to edge" origin/$SOURCE_BRANCH
if git diff --quiet edge; then
echo "No changes to merge from $SOURCE_BRANCH to edge"
echo "NO_CHANGES=true" >> $GITHUB_ENV
else
echo "Pushing $BRANCH_NAME for PR to edge"
git reset HEAD docs/config.toml docs/layouts/partials/hooks/body-end.html
git push --set-upstream origin $BRANCH_NAME
fi
# Create a PR from the new branch to edge
- name: Create pull request
if: env.NO_CHANGES != 'true'
env:
GITHUB_TOKEN: ${{ secrets.GH_RAD_CI_BOT_PAT}}
run: gh pr create --title "Upmerge to edge" --body "Upmerge to edge (kicked off by @${{ github.triggering_actor }})" --base edge --head $BRANCH_NAME
8 changes: 4 additions & 4 deletions docs/config.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
baseURL = "https://edge.docs.radapp.io/"
baseURL = "https://docs.radapp.io/"
languageCode = "en-us"
title = "Radius Docs"
theme = "docsy"
Expand Down Expand Up @@ -67,17 +67,17 @@ tag = "tags"

[params]
copyright = "The Radius Authors. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see the https://linuxfoundation.org/trademark-usage/ page."
version = "edge"
version = "v0.36"
tag_version = "latest"
chart_version = "0.26.0"
chart_version = "0.36.0"

# Algolia Search
algolia_docsearch = true

# GitHub Information
github_repo = "https://github.com/radius-project/docs"
github_subdir = "docs"
github_branch = "edge"
github_branch = "v0.36"
github_project_repo = "https://github.com/radius-project/radius"

# Versioning
Expand Down
2 changes: 1 addition & 1 deletion docs/layouts/partials/hooks/body-end.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
container: '#docsearch',
appId: 'ED67NSVSZS',
apiKey: '21e2920c3a9c29b98cbc382694413f29',
indexName: 'radapp-dev-edge',
indexName: 'radapp-dev',
});
</script>
{{ end }}
Expand Down

0 comments on commit 81211b0

Please sign in to comment.