fix(release): merge develop into main #174
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
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,64 @@ | ||
| <table border="0" cellspacing="0" cellpadding="0"> | ||
| <tr> | ||
| <td><img src="https://github.com/LerianStudio.png" width="72" alt="Lerian" /></td> | ||
| <td><h1>backmerge-pr</h1></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| Creates a PR to backmerge a source branch into a target branch when a direct push fails. Checks for existing open PRs to avoid duplicates. | ||
|
|
||
| Typically used as a fallback in the release workflow when the `@saithodev/semantic-release-backmerge` plugin fails to push directly (non-fast-forward). | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Input | Description | Required | Default | | ||
| |-------|-------------|----------|---------| | ||
| | `github-token` | GitHub token with pull-requests write permission | Yes | | | ||
| | `source-branch` | Source branch to merge from (e.g., main) | Yes | | | ||
| | `target-branch` | Target branch to merge into | No | `develop` | | ||
| | `version` | Release version for the PR title | Yes | | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Output | Description | | ||
| |--------|-------------| | ||
| | `pr-url` | URL of the created or existing PR | | ||
| | `pr-number` | Number of the created or existing PR | | ||
|
|
||
| ## Usage as composite step | ||
|
|
||
| ```yaml | ||
| - name: Create backmerge PR | ||
| uses: LerianStudio/github-actions-shared-workflows/src/config/backmerge-pr@v1.x.x | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| source-branch: main | ||
| target-branch: develop | ||
| version: ${{ steps.semantic.outputs.new_release_version }} | ||
| ``` | ||
|
|
||
| ## Usage in release workflow (fallback pattern) | ||
|
|
||
| ```yaml | ||
| - name: Semantic Release | ||
| uses: cycjimmy/semantic-release-action@v6 | ||
| id: semantic | ||
| continue-on-error: true | ||
| ... | ||
|
|
||
| - name: Backmerge PR fallback | ||
| if: steps.semantic.outcome == 'failure' && steps.semantic.outputs.new_release_published == 'true' | ||
| uses: LerianStudio/github-actions-shared-workflows/src/config/backmerge-pr@v1.x.x | ||
| with: | ||
| github-token: ${{ steps.app-token.outputs.token }} | ||
| source-branch: ${{ github.ref_name }} | ||
| version: ${{ steps.semantic.outputs.new_release_version }} | ||
| ``` | ||
|
|
||
| ## Required permissions | ||
|
|
||
| ```yaml | ||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| ``` |
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,67 @@ | ||
| name: Backmerge PR | ||
| description: "Creates a PR to backmerge a source branch into a target branch when a direct push fails." | ||
|
|
||
| inputs: | ||
| github-token: | ||
| description: GitHub token with pull-requests write permission | ||
| required: true | ||
| source-branch: | ||
| description: Source branch to merge from (e.g., main) | ||
| required: true | ||
| target-branch: | ||
| description: Target branch to merge into (e.g., develop) | ||
| required: false | ||
| default: develop | ||
| version: | ||
| description: Release version for the PR title (e.g., 1.20.1) | ||
| required: true | ||
|
|
||
| outputs: | ||
| pr-url: | ||
| description: URL of the created PR (empty if PR already existed or was not needed) | ||
| value: ${{ steps.create-pr.outputs.pr_url }} | ||
| pr-number: | ||
| description: Number of the created or existing PR | ||
| value: ${{ steps.create-pr.outputs.pr_number }} | ||
|
|
||
| runs: | ||
| using: composite | ||
| steps: | ||
| - name: Create backmerge PR | ||
| id: create-pr | ||
| shell: bash | ||
| env: | ||
| GH_TOKEN: ${{ inputs.github-token }} | ||
| SOURCE_BRANCH: ${{ inputs.source-branch }} | ||
| TARGET_BRANCH: ${{ inputs.target-branch }} | ||
| VERSION: ${{ inputs.version }} | ||
| run: | | ||
| # Check if a backmerge PR already exists | ||
| EXISTING_PR=$(gh pr list --base "${TARGET_BRANCH}" --head "${SOURCE_BRANCH}" --state open --json number,url --jq '.[0]') | ||
| if [ -n "$EXISTING_PR" ]; then | ||
| PR_NUM=$(echo "$EXISTING_PR" | jq -r '.number') | ||
| PR_URL=$(echo "$EXISTING_PR" | jq -r '.url') | ||
| echo "::notice::Backmerge PR #${PR_NUM} already exists: ${PR_URL}" | ||
| echo "pr_number=${PR_NUM}" >> "$GITHUB_OUTPUT" | ||
| echo "pr_url=${PR_URL}" >> "$GITHUB_OUTPUT" | ||
| exit 0 | ||
| fi | ||
|
|
||
| PR_BODY="## Description | ||
|
|
||
| Automated backmerge of release \`${VERSION}\` from \`${SOURCE_BRANCH}\` to \`${TARGET_BRANCH}\`. | ||
|
|
||
| The automatic backmerge push failed because \`${TARGET_BRANCH}\` has diverged from \`${SOURCE_BRANCH}\`. This PR needs a manual merge to resolve any conflicts. | ||
|
|
||
| > **Note:** This PR was created automatically by the release workflow." | ||
|
|
||
| PR_URL=$(gh pr create \ | ||
| --base "${TARGET_BRANCH}" \ | ||
| --head "${SOURCE_BRANCH}" \ | ||
| --title "chore(release): backmerge ${VERSION}" \ | ||
| --body "${PR_BODY}") | ||
|
|
||
| PR_NUM=$(echo "$PR_URL" | grep -oE '[0-9]+$') | ||
| echo "pr_number=${PR_NUM}" >> "$GITHUB_OUTPUT" | ||
| echo "pr_url=${PR_URL}" >> "$GITHUB_OUTPUT" | ||
| echo "::notice::Backmerge push failed — created PR #${PR_NUM}: ${PR_URL}" | ||
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 | ||||
|---|---|---|---|---|---|---|
| @@ -1,60 +1,14 @@ | ||||||
| name: Validate PR Description | ||||||
| description: "Checks that the PR description is not empty." | ||||||
|
|
||||||
| runs: | ||||||
| using: composite | ||||||
| steps: | ||||||
| - name: Check description | ||||||
| uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8 | ||||||
|
There was a problem hiding this comment. Fix yamllint spacing warning. Pipeline reports: "too few spaces before comment: expected 2". Add a space before the version comment. Proposed fix- uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
+ uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8📝 Committable suggestion
Suggested change
🧰 Tools🪛 GitHub Actions: Self — PR Validation[warning] 8-8: Yamllint warning: too few spaces before comment: expected 2 (comments) 🤖 Prompt for AI Agents |
||||||
| with: | ||||||
| script: | | ||||||
| const body = (context.payload.pull_request.body || '').trim(); | ||||||
| if (body.length === 0) { | ||||||
| core.setFailed('PR description is empty. Please provide a description.'); | ||||||
| } | ||||||
Oops, something went wrong.
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.
Output description contradicts implementation.
Line 21 states
pr-urlis "empty if PR already existed" but the implementation at lines 43-46 setspr_urlfor existing PRs. Either update the description or the behavior.Suggested fix
🤖 Prompt for AI Agents