Skip to content

Release Plugin

Release Plugin #34

Workflow file for this run

# GitHub Actions Workflow created for handling the release process based on the draft release prepared with the Build workflow.
# Running the publishPlugin task requires all following secrets to be provided: PUBLISH_TOKEN, PRIVATE_KEY, PRIVATE_KEY_PASSWORD, CERTIFICATE_CHAIN.
# See https://plugins.jetbrains.com/docs/intellij/plugin-signing.html for more information.
name: Release Plugin
on:
release:
types: [released]
jobs:
# Prepare and publish the plugin to JetBrains Marketplace repository
release:
name: Publish Plugin
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
# Check out the current repository
- name: Fetch Sources
uses: actions/checkout@v4
with:
ref: ${{ github.event.release.tag_name }}
# Set up Java environment for the next steps
- name: Setup Java
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: 11
# Setup Gradle
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v3
with:
gradle-home-cache-cleanup: true
- name: Grant execute permission for Gradle wrapper
run: chmod +x ./gradlew
# Set environment variables
- name: Export Properties
id: properties
shell: bash
run: |
PROPERTIES="$(./gradlew properties --console=plain -q)"
VERSION="$(echo "$PROPERTIES" | grep "^version:" | cut -f2- -d ' ')"
NAME="$(echo "$PROPERTIES" | grep "^name:" | cut -f2- -d ' ')"
CHANGELOG="$(cat << 'EOM' | sed -e 's/^[[:space:]]*$//g' -e '/./,$!d'
${{ github.event.release.body }}
EOM
)"
# 转义空格
NAME="$(echo "$NAME" | sed 's/ /\\ /g')"
echo "name: $NAME"
echo "version: $VERSION"
echo "releaseTagName: ${{ github.event.release.tag_name }}"
echo "changelog:"
echo "$CHANGELOG"
echo "name=$NAME" >> $GITHUB_OUTPUT
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "pluginName=$NAME-$VERSION.zip" >> $GITHUB_OUTPUT
echo "pluginSignedName=$NAME-$VERSION-signed.zip" >> $GITHUB_OUTPUT
echo "changelog<<EOF" >> $GITHUB_OUTPUT
echo "$CHANGELOG" >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
# Update Unreleased section with the current release note
- name: Patch Changelog
if: ${{ steps.properties.outputs.changelog != '' }}
env:
CHANGELOG: ${{ steps.properties.outputs.changelog }}
run: |
./gradlew patchChangelog --release-note="$CHANGELOG"
- name: Cat Changelog
if: ${{ steps.properties.outputs.changelog != '' }}
run: |
cat ./CHANGELOG.md
# Publish the plugin to JetBrains Marketplace
- name: Publish Plugin
env:
PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }}
CERTIFICATE_CHAIN: ${{ secrets.CERTIFICATE_CHAIN }}
PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
PRIVATE_KEY_PASSWORD: ${{ secrets.PRIVATE_KEY_PASSWORD }}
run: ./gradlew publishPlugin
- name: Move zip
run: |
echo "${{ steps.properties.outputs.pluginName }}"
echo "${{ steps.properties.outputs.pluginSignedName }}"
# 移除原本未签名的压缩包
mkdir test
mv ./build/distributions/${{ steps.properties.outputs.pluginName }} test/${{ steps.properties.outputs.pluginName }}
echo "已移除未签名压缩包,查看文件:"
echo "/build/distributions:"
ls ./build/distributions
echo "/test:"
ls ./test
mv ./build/distributions/${{ steps.properties.outputs.pluginSignedName }} ./build/distributions/${{ steps.properties.outputs.pluginName }}
echo "已将签名压缩包更名,查看文件:"
echo "/build/distributions:"
ls ./build/distributions
echo "/test:"
ls ./test
# Upload artifact as a release asset
- name: Upload Release Asset
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: gh release upload ${{ github.event.release.tag_name }} ./build/distributions/${{ steps.properties.outputs.pluginName }}
- name: Check If Branch Exists
run: |
VERSION="${{ github.event.release.tag_name }}"
BRANCH="changelog-update-$VERSION"
echo "branch_name=$BRANCH" >> $GITHUB_ENV
if git ls-remote --exit-code --heads origin "$BRANCH"; then
echo "[$BRANCH] 分支存在"
echo "branch_exists=true" >> $GITHUB_ENV
else
echo "[$BRANCH] 分支不存在"
echo "branch_exists=false" >> $GITHUB_ENV
fi
- name: Delete Branch If Exists
if: env.branch_exists == 'true'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
branch="${{ env.branch_name }}"
git push origin --delete "$branch"
# Create a pull request
- name: Create Pull Request
if: ${{ steps.properties.outputs.changelog != '' }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
VERSION="${{ github.event.release.tag_name }}"
BRANCH="changelog-update-$VERSION"
LABEL="release changelog"
git config user.email "[email protected]"
git config user.name "GitHub Action"
git checkout -b $BRANCH
git commit -am "Changelog update - $VERSION"
git push --set-upstream origin $BRANCH
gh label create "$LABEL" \
--description "Pull requests with release changelog update" \
--force \
|| true
gh pr create \
--title "Changelog update - \`$VERSION\`" \
--body "Current pull request contains patched \`CHANGELOG.md\` file for the \`$VERSION\` version." \
--label "$LABEL" \
--head $BRANCH