-
Notifications
You must be signed in to change notification settings - Fork 870
[Release] Automate most manual steps #9419
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
Open
acstll
wants to merge
4
commits into
elastic:main
Choose a base branch
from
acstll:feat/release-automation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+303
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
65f07ec
[Release] Automate some manual steps (WIP)
acstll 5320ab3
Merge remote-tracking branch 'upstream/main' into feat/release-automa…
acstll efb7da0
[Release] Polish automation scripts
acstll 88aa4e9
[Release] Add install script for reviewers
acstll File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # Installs the release scripts to ~/.local/bin so they can be run | ||
| # from anywhere inside the EUI repo without checking out this branch. | ||
| # | ||
| # Usage: bash <(curl -s https://raw.githubusercontent.com/acstll/eui/feat/release-automation/scripts/release-install.sh) | ||
| # | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| BRANCH="feat/release-automation" | ||
| BASE_URL="https://raw.githubusercontent.com/acstll/eui/${BRANCH}/scripts" | ||
| DEST="${HOME}/.local/bin" | ||
|
|
||
| SCRIPTS=(release-prep.sh release-publish.sh) | ||
|
|
||
| mkdir -p "$DEST" | ||
|
|
||
| for script in "${SCRIPTS[@]}"; do | ||
| echo "Installing ${script} → ${DEST}/${script}" | ||
| curl -fsSL "${BASE_URL}/${script}" -o "${DEST}/${script}" | ||
| chmod +x "${DEST}/${script}" | ||
| done | ||
|
|
||
| echo "" | ||
| echo "Done. Make sure ~/.local/bin is in your PATH, then run from the EUI repo:" | ||
| echo " release-prep.sh" | ||
| echo " release-publish.sh" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,135 @@ | ||||||
| #!/usr/bin/env bash | ||||||
| # | ||||||
| # Official release preparation script (pre-PR) | ||||||
| # | ||||||
| # Automates initial steps of the process: | ||||||
| # - Log out of npm | ||||||
| # - Checkout main, pull latest from upstream | ||||||
| # - Create a timestamped release branch | ||||||
| # - Build the release CLI | ||||||
| # - Run the release dry-run (interactive) | ||||||
| # - (User confirms in the interactive CLI) | ||||||
| # - Push the branch to origin and open a PR | ||||||
| # | ||||||
| # Usage: yarn release:prep | ||||||
| # | ||||||
|
|
||||||
| set -euo pipefail | ||||||
|
|
||||||
| RED='\033[0;31m' | ||||||
| GREEN='\033[0;32m' | ||||||
| YELLOW='\033[0;33m' | ||||||
| BOLD='\033[1m' | ||||||
| RESET='\033[0m' | ||||||
|
|
||||||
| step() { | ||||||
| echo "" | ||||||
| echo -e "${GREEN}${BOLD}[$1]${RESET} $2" | ||||||
| } | ||||||
|
|
||||||
| warn() { | ||||||
| echo -e "${YELLOW}Warning:${RESET} $1" | ||||||
| } | ||||||
|
|
||||||
| error() { | ||||||
| echo -e "${RED}Error:${RESET} $1" >&2 | ||||||
| exit 1 | ||||||
| } | ||||||
|
|
||||||
| REPO_ROOT=$(git rev-parse --show-toplevel 2>/dev/null) || error "Not inside a git repository" | ||||||
| cd "$REPO_ROOT" | ||||||
|
|
||||||
| PACKAGE_DIRS=(packages/eui packages/eui-theme-common packages/eui-theme-borealis packages/docusaurus-preset packages/docusaurus-theme packages/eslint-plugin) | ||||||
|
|
||||||
| git remote get-url upstream &>/dev/null || error "'upstream' remote not found. Please add it: git remote add upstream git@github.com:elastic/eui.git" | ||||||
|
|
||||||
| # Bail early if there are uncommitted changes | ||||||
| if [[ -n "$(git status --porcelain)" ]]; then | ||||||
| error "Working tree is dirty. Please commit or stash your changes before running this script." | ||||||
| fi | ||||||
|
|
||||||
| step "1/8" "Ensuring npm is not authenticated..." | ||||||
| npm logout 2>/dev/null || true | ||||||
| yarn npm logout 2>/dev/null || true | ||||||
|
|
||||||
| step "2/8" "Checking out main branch..." | ||||||
| git checkout main | ||||||
|
|
||||||
| step "3/8" "Pulling latest changes from upstream..." | ||||||
| git pull upstream main | ||||||
|
|
||||||
| BRANCH_NAME="release/$(date +%s)" | ||||||
| step "4/8" "Creating release branch: ${BOLD}${BRANCH_NAME}${RESET}" | ||||||
| git checkout -b "$BRANCH_NAME" | ||||||
|
|
||||||
| step "5/8" "Installing dependencies and building release CLI..." | ||||||
| yarn | ||||||
|
||||||
| yarn | |
| yarn install --immutable |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # Official release publish script (post-merge) | ||
| # | ||
| # Automates final steps of the process: | ||
| # - Detects the EUI version and changed workspaces | ||
| # - Tags the merge commit | ||
| # - Pushes the tag to upstream | ||
| # - Triggers the GitHub Actions release workflow | ||
| # - Creates a GitHub release | ||
| # | ||
| # Usage: yarn release:publish [merge-commit-sha] | ||
| # | ||
| # If no SHA is provided, defaults to HEAD on main. | ||
| # | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| RED='\033[0;31m' | ||
| GREEN='\033[0;32m' | ||
| YELLOW='\033[0;33m' | ||
| BOLD='\033[1m' | ||
| RESET='\033[0m' | ||
|
|
||
| step() { | ||
| echo "" | ||
| echo -e "${GREEN}${BOLD}[$1]${RESET} $2" | ||
| } | ||
|
|
||
| warn() { | ||
| echo -e "${YELLOW}Warning:${RESET} $1" | ||
| } | ||
|
|
||
| error() { | ||
| echo -e "${RED}Error:${RESET} $1" >&2 | ||
| exit 1 | ||
| } | ||
|
|
||
| REPO_ROOT=$(git rev-parse --show-toplevel 2>/dev/null) || error "Not inside a git repository" | ||
| cd "$REPO_ROOT" | ||
|
|
||
| PACKAGE_DIRS=(packages/eui packages/eui-theme-common packages/eui-theme-borealis packages/docusaurus-preset packages/docusaurus-theme packages/eslint-plugin) | ||
|
|
||
| git remote get-url upstream &>/dev/null || error "'upstream' remote not found" | ||
|
|
||
| step "1/6" "Updating main branch..." | ||
| git checkout main | ||
| git pull upstream main | ||
| git fetch upstream --tags | ||
|
Comment on lines
+46
to
+49
|
||
|
|
||
| MERGE_SHA="${1:-$(git rev-parse HEAD)}" | ||
|
|
||
| step "2/6" "Detecting release details from ${BOLD}${MERGE_SHA:0:12}${RESET}..." | ||
|
|
||
| EUI_VERSION=$(git show "${MERGE_SHA}:packages/eui/package.json" | node -p "JSON.parse(require('fs').readFileSync('/dev/stdin','utf8')).version") | ||
| TAG_NAME="v${EUI_VERSION}" | ||
|
|
||
| if git rev-parse "$TAG_NAME" &>/dev/null; then | ||
| error "Tag ${TAG_NAME} already exists. Has this release already been published?" | ||
| fi | ||
|
|
||
| PREV_TAG=$(git describe --tags --abbrev=0 "${MERGE_SHA}^" 2>/dev/null) || error "Could not find a previous release tag" | ||
|
|
||
| # Detect changed workspaces and collect changelog entries for the GitHub release | ||
| CHANGED_WORKSPACES="" | ||
| RELEASE_BODY="" | ||
|
|
||
| for pkg_dir in "${PACKAGE_DIRS[@]}"; do | ||
| pkg_json="${pkg_dir}/package.json" | ||
|
|
||
| git show "${MERGE_SHA}:${pkg_json}" &>/dev/null || continue | ||
|
|
||
| new_version=$(git show "${MERGE_SHA}:${pkg_json}" | node -p "JSON.parse(require('fs').readFileSync('/dev/stdin','utf8')).version") | ||
| old_version=$(git show "${PREV_TAG}:${pkg_json}" 2>/dev/null | node -p "JSON.parse(require('fs').readFileSync('/dev/stdin','utf8')).version" 2>/dev/null || echo "") | ||
|
|
||
| if [[ "$new_version" != "$old_version" ]]; then | ||
| pkg_name=$(git show "${MERGE_SHA}:${pkg_json}" | node -p "JSON.parse(require('fs').readFileSync('/dev/stdin','utf8')).name") | ||
|
|
||
| if [[ -n "$CHANGED_WORKSPACES" ]]; then | ||
| CHANGED_WORKSPACES="${CHANGED_WORKSPACES},${pkg_name}" | ||
| else | ||
| CHANGED_WORKSPACES="${pkg_name}" | ||
| fi | ||
|
|
||
| # Extract changelog section for this version | ||
| changelog_file=$(ls -t "${pkg_dir}"/changelogs/CHANGELOG_*.md 2>/dev/null | head -1) | ||
| if [[ -n "$changelog_file" ]]; then | ||
| escaped_version="${new_version//./\\.}" | ||
| changelog_section=$(awk "/^## \[\`v${escaped_version}\`\]/{found=1; next} /^## \[/{if(found) exit} found" "$changelog_file") | ||
| if [[ -n "$changelog_section" ]]; then | ||
| RELEASE_BODY="${RELEASE_BODY}### \`${pkg_name}\` [v${new_version}](https://github.com/elastic/eui/blob/main/${changelog_file}) | ||
| ${changelog_section} | ||
| " | ||
|
Comment on lines
+85
to
+93
|
||
| fi | ||
| fi | ||
| fi | ||
| done | ||
|
|
||
| if [[ -z "$CHANGED_WORKSPACES" ]]; then | ||
| error "No changed workspaces detected. Are you sure the release PR was merged?" | ||
| fi | ||
|
|
||
| step "3/6" "Release summary" | ||
| echo "" | ||
| echo -e " Tag: ${BOLD}${TAG_NAME}${RESET}" | ||
| echo -e " Commit: ${BOLD}${MERGE_SHA:0:12}${RESET}" | ||
| echo -e " Previous tag: ${BOLD}${PREV_TAG}${RESET}" | ||
| echo -e " Workspaces: ${BOLD}${CHANGED_WORKSPACES}${RESET}" | ||
| echo "" | ||
| read -r -p "Proceed with tagging and triggering the release? (y/N) " confirm | ||
| if [[ "$confirm" != "y" && "$confirm" != "Y" ]]; then | ||
| echo "Aborted." | ||
| exit 0 | ||
| fi | ||
|
|
||
| step "4/6" "Creating and pushing tag ${BOLD}${TAG_NAME}${RESET}..." | ||
| git tag -a "$TAG_NAME" "$MERGE_SHA" -m "@elastic/eui ${TAG_NAME}" | ||
| git push upstream "$TAG_NAME" --no-verify | ||
|
|
||
| step "5/6" "Triggering release workflow..." | ||
| gh workflow run release.yml \ | ||
| --repo elastic/eui \ | ||
| -f release_ref="$MERGE_SHA" \ | ||
| -f type=official \ | ||
| -f workspaces="$CHANGED_WORKSPACES" \ | ||
| -f dry_run=false | ||
|
|
||
| step "6/6" "Creating GitHub release..." | ||
| gh release create "$TAG_NAME" \ | ||
| --repo elastic/eui \ | ||
| --title "$TAG_NAME" \ | ||
| --notes "$RELEASE_BODY" | ||
|
|
||
| echo "" | ||
| echo -e "${GREEN}${BOLD}Release triggered!${RESET}" | ||
| echo "" | ||
| echo -e " Release: ${BOLD}https://github.com/elastic/eui/releases/tag/${TAG_NAME}${RESET}" | ||
| echo -e " Workflow: ${BOLD}https://github.com/elastic/eui/actions/workflows/release.yml${RESET}" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
release-install.shis hardcoded to download scripts from a personal fork/branch (acstll/eui+feat/release-automation). Once this PR is merged, that URL/branch may not exist and the installer will break. Consider switching tohttps://raw.githubusercontent.com/elastic/eui/main/scripts(or dynamically deriving the repo/branch via args/env vars) so the install script keeps working long-term.