This repository has been archived by the owner on Nov 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Ritesh Kumar Singh
authored and
Ritesh Kumar Singh
committed
Aug 7, 2023
0 parents
commit 9071085
Showing
66 changed files
with
3,393 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,11 @@ | ||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. |
This file contains 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,11 @@ | ||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains 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,10 @@ | ||
# Dependabot configuration: | ||
# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates | ||
|
||
version: 2 | ||
updates: | ||
# Maintain dependencies for GitHub Actions | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" |
This file contains 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,11 @@ | ||
### Summary | ||
_Provide an overview..._ | ||
|
||
### Details | ||
_Add more context to describe the changes..._ | ||
|
||
### Checks | ||
- [ ] Tested Changes | ||
- [ ] Test Coverage | ||
|
||
### Assets |
This file contains 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,201 @@ | ||
# GitHub Actions Workflow is created for testing and preparing the plugin release in the following steps: | ||
# GitHub Actions reference: https://help.github.com/en/actions | ||
|
||
name: Build | ||
on: | ||
push: | ||
branches: | ||
- main | ||
paths-ignore: | ||
- '*.md' | ||
pull_request: | ||
|
||
jobs: | ||
build: | ||
name: Build | ||
runs-on: ubuntu-latest | ||
outputs: | ||
version: ${{ steps.properties.outputs.version }} | ||
changelog: ${{ steps.properties.outputs.changelog }} | ||
pluginVerifierHomeDir: ${{ steps.properties.outputs.pluginVerifierHomeDir }} | ||
steps: | ||
# Free GitHub Actions Environment Disk Space | ||
- name: Maximize Build Space | ||
run: | | ||
sudo rm -rf /usr/share/dotnet | ||
sudo rm -rf /usr/local/lib/android | ||
sudo rm -rf /opt/ghc | ||
# Check out current repository | ||
- name: Checkout repo | ||
uses: actions/checkout@v3 | ||
|
||
# Validate wrapper | ||
- name: Gradle wrapper validation | ||
uses: gradle/[email protected] | ||
|
||
# Setup Java 11 environment for the next steps | ||
- name: Setup jdk | ||
uses: actions/setup-java@v3 | ||
with: | ||
distribution: zulu | ||
java-version: 11 | ||
|
||
# Set-up gradle action | ||
- name: Setup gradle | ||
uses: gradle/gradle-build-action@v2 | ||
|
||
# Set environment variables | ||
- name: Export Properties | ||
id: properties | ||
shell: bash | ||
run: | | ||
PROPERTIES="$(./gradlew properties --console=plain -q)" | ||
VERSION="$(echo "$PROPERTIES" | grep "^pluginVersion:" | cut -f2- -d ' ')" | ||
CHANGELOG="$(./gradlew getChangelog --unreleased --no-header --console=plain -q)" | ||
echo "version=$VERSION" >> $GITHUB_OUTPUT | ||
echo "pluginVerifierHomeDir=~/.pluginVerifier" >> $GITHUB_OUTPUT | ||
echo "changelog<<EOF" >> $GITHUB_OUTPUT | ||
echo "$CHANGELOG" >> $GITHUB_OUTPUT | ||
echo "EOF" >> $GITHUB_OUTPUT | ||
./gradlew listProductsReleases # prepare list of IDEs for Plugin Verifier | ||
# Build plugin | ||
- name: Build plugin | ||
run: ./gradlew buildPlugin | ||
|
||
# Prepare plugin archive content for creating artifact | ||
- name: Prepare Plugin Artifact | ||
id: artifact | ||
shell: bash | ||
run: | | ||
cd ${{ github.workspace }}/build/distributions | ||
FILENAME=`ls *.zip` | ||
unzip "$FILENAME" -d content | ||
echo "filename=${FILENAME:0:-4}" >> $GITHUB_OUTPUT | ||
# Store already-built plugin as an artifact for downloading | ||
- name: Upload artifact | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: ${{ steps.artifact.outputs.filename }} | ||
path: ./build/distributions/content/*/* | ||
|
||
# Run test | ||
test: | ||
name: Test | ||
needs: [ build ] | ||
runs-on: ubuntu-latest | ||
steps: | ||
# Check out current repository | ||
- name: Fetch Sources | ||
uses: actions/checkout@v3 | ||
|
||
# Setup Java 11 environment for the next steps | ||
- name: Setup Java | ||
uses: actions/setup-java@v3 | ||
with: | ||
distribution: zulu | ||
java-version: 11 | ||
|
||
# Set-up gradle action | ||
- name: Setup Gradle | ||
uses: gradle/gradle-build-action@v2 | ||
|
||
# Run tests | ||
- name: Run Tests | ||
run: ./gradlew check | ||
|
||
# Collect Tests Result of failed tests | ||
- name: Collect Tests Result | ||
if: ${{ failure() }} | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: tests-result | ||
path: ${{ github.workspace }}/build/reports/tests | ||
|
||
# Run plugin structure verification along with IntelliJ Plugin Verifier | ||
verify: | ||
name: Verify plugin | ||
needs: [ build, test ] | ||
runs-on: ubuntu-latest | ||
steps: | ||
# Check out current repository | ||
- name: Fetch Sources | ||
uses: actions/checkout@v3 | ||
|
||
# Setup Java 11 environment for the next steps | ||
- name: Setup Java | ||
uses: actions/setup-java@v3 | ||
with: | ||
distribution: zulu | ||
java-version: 11 | ||
# Set-up gradle action | ||
- name: Setup Gradle | ||
uses: gradle/gradle-build-action@v2 | ||
|
||
# Cache Plugin Verifier IDEs | ||
- name: Setup Plugin Verifier IDEs Cache | ||
uses: actions/cache@v3 | ||
with: | ||
path: ${{ needs.build.outputs.pluginVerifierHomeDir }}/ides | ||
key: plugin-verifier-${{ hashFiles('build/listProductsReleases.txt') }} | ||
|
||
# Run Verify Plugin task and IntelliJ Plugin Verifier tool | ||
- name: Run Plugin Verification tasks | ||
run: ./gradlew runPluginVerifier -Dplugin.verifier.home.dir=${{ needs.build.outputs.pluginVerifierHomeDir }} | ||
|
||
# Collect Plugin Verifier Result | ||
- name: Collect Plugin Verifier Result | ||
if: ${{ always() }} | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: pluginVerifier-result | ||
path: ${{ github.workspace }}/build/reports/pluginVerifier | ||
|
||
# Prepare a draft release for GitHub Releases page for the manual verification | ||
# If accepted and published, release workflow would be triggered | ||
releaseDraft: | ||
name: Release draft | ||
if: github.event_name != 'pull_request' | ||
needs: [ build, verify ] | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
steps: | ||
# Check out current repository | ||
- name: Fetch Sources | ||
uses: actions/checkout@v3 | ||
|
||
# Setup Java 11 environment for the next steps | ||
- name: Setup Java | ||
uses: actions/setup-java@v3 | ||
with: | ||
distribution: zulu | ||
java-version: 11 | ||
|
||
# Remove old release drafts by using the curl request for the available releases with a draft flag | ||
- name: Remove Old Release Drafts | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: | | ||
gh api repos/{owner}/{repo}/releases \ | ||
--jq '.[] | select(.draft == true) | .id' \ | ||
| xargs -I '{}' gh api -X DELETE repos/{owner}/{repo}/releases/{} | ||
# Create a new release draft which is not publicly visible and requires manual acceptance | ||
- name: Create Release Draft | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: | | ||
gh release create v${{ needs.build.outputs.version }} \ | ||
--draft \ | ||
--title "v${{ needs.build.outputs.version }}" \ | ||
--notes "$(cat << 'EOM' | ||
${{ needs.build.outputs.changelog }} | ||
EOM | ||
)" |
This file contains 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,100 @@ | ||
# 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 | ||
on: | ||
release: | ||
types: [prereleased, 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 current repository | ||
- name: Fetch Sources | ||
uses: actions/checkout@v3 | ||
with: | ||
ref: ${{ github.event.release.tag_name }} | ||
|
||
# Setup Java environment for the next steps | ||
- name: Setup Java | ||
uses: actions/setup-java@v3 | ||
with: | ||
distribution: zulu | ||
java-version: 11 | ||
|
||
# Setup Gradle | ||
- name: Setup Gradle | ||
uses: gradle/gradle-build-action@v2 | ||
|
||
# Set environment variables | ||
- name: Export Properties | ||
id: properties | ||
shell: bash | ||
run: | | ||
CHANGELOG="$(cat << 'EOM' | sed -e 's/^[[:space:]]*$//g' -e '/./,$!d' | ||
${{ github.event.release.body }} | ||
EOM | ||
)" | ||
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" | ||
# 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 | ||
|
||
# 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/* | ||
|
||
# Create 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" \ | ||
|| 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 |
This file contains 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,5 @@ | ||
.DS_Store | ||
.gradle | ||
.idea | ||
.qodana | ||
build |
This file contains 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,24 @@ | ||
<component name="ProjectRunConfigurationManager"> | ||
<configuration default="false" name="Run Plugin" type="GradleRunConfiguration" factoryName="Gradle"> | ||
<log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/system/log/idea.log"/> | ||
<ExternalSystemSettings> | ||
<option name="executionName"/> | ||
<option name="externalProjectPath" value="$PROJECT_DIR$"/> | ||
<option name="externalSystemIdString" value="GRADLE"/> | ||
<option name="scriptParameters" value=""/> | ||
<option name="taskDescriptions"> | ||
<list/> | ||
</option> | ||
<option name="taskNames"> | ||
<list> | ||
<option value="runIde"/> | ||
</list> | ||
</option> | ||
<option name="vmOptions" value=""/> | ||
</ExternalSystemSettings> | ||
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess> | ||
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess> | ||
<DebugAllEnabled>false</DebugAllEnabled> | ||
<method v="2"/> | ||
</configuration> | ||
</component> |
Oops, something went wrong.