Skip to content

Remove outdated GitHub release issue template#3286

Merged
acicovic merged 2 commits intodevelopfrom
remove/outdated-github-release-issue-template
Apr 22, 2025
Merged

Remove outdated GitHub release issue template#3286
acicovic merged 2 commits intodevelopfrom
remove/outdated-github-release-issue-template

Conversation

@acicovic
Copy link
Collaborator

@acicovic acicovic commented Apr 22, 2025

Description

With this PR we're removing our older GitHub release issue template, effectively replacing it with our new one.

Motivation and context

Keep our code updated, reduce noise and possible confusion of which template should be used.

How has this been tested?

No functionality changes.

Summary by CodeRabbit

  • Documentation
    • Updated the release process instructions to reflect new automated steps using GitHub Actions.
    • Consolidated steps for creating a release and deploying to WordPress.org for improved clarity.
    • Removed an older release issue template to streamline documentation.

@acicovic acicovic added the Maintenance & Fixes Ticket/PR related to codebase maintenance tasks label Apr 22, 2025
@acicovic acicovic added this to the 3.18.1 milestone Apr 22, 2025
@acicovic acicovic self-assigned this Apr 22, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 22, 2025

📝 Walkthrough

Walkthrough

This update modifies the GitHub release issue templates for the wp-parsely plugin. The older release template file (release-template-new.md) was deleted, removing a detailed checklist for managing releases. The remaining release template (release-template.md) was updated to reflect a streamlined, more automated process: manual version bumping steps were replaced with instructions to use a dedicated GitHub Action, and the release and deployment steps were consolidated. No code or exported entities were changed, as all modifications are limited to markdown documentation.

Changes

File(s) Change Summary
.github/ISSUE_TEMPLATE/release-template-new.md Deleted the detailed release issue template containing a step-by-step checklist for plugin releases.
.github/ISSUE_TEMPLATE/release-template.md Updated instructions: replaced manual version bumping with a GitHub Action, consolidated release steps.

Possibly related PRs


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@acicovic acicovic marked this pull request as ready for review April 22, 2025 09:32
@acicovic acicovic requested a review from a team as a code owner April 22, 2025 09:32
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/ISSUE_TEMPLATE/release-template.md (1)

44-46: Use proper Markdown headings for step titles
Markdownlint (MD036) flags emphasis as headings on these lines. To improve accessibility and maintain consistency, convert bolded step titles into actual Markdown headings. For example:

- **3. Create release and deploy to WordPress.org**
+ ### 3. Create release and deploy to WordPress.org

Apply the same pattern to all numbered steps (1., 2., etc.) under the “Release process” section.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

44-44: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0907e07 and f29a0f9.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/release-template-new.md (0 hunks)
  • .github/ISSUE_TEMPLATE/release-template.md (1 hunks)
💤 Files with no reviewable changes (1)
  • .github/ISSUE_TEMPLATE/release-template-new.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.github/ISSUE_TEMPLATE/release-template.md

40-40: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


44-44: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

🔇 Additional comments (1)
.github/ISSUE_TEMPLATE/release-template.md (1)

36-37:

Details

✅ Verification successful

Adopt automated version bump Action
The new step correctly replaces the manual PHP script with the bump-version.yml GitHub Action to bump versions and update the changelog. This will reduce manual errors and keep releases consistent.

Please verify that the referenced workflow files actually exist in .github/workflows/. You can run this quick check locally:


🏁 Script executed:

#!/bin/bash
# Description: Verify required GitHub Actions workflows are present
set -e
for wf in bump-version.yml release-plugin.yml; do
  if [ ! -f .github/workflows/$wf ]; then
    echo "ERROR: Missing workflow .github/workflows/$wf" >&2
    exit 1
  fi
done
echo "✔ All referenced workflows found."

Length of output: 287


Automated version bump Action workflows verified

The bump-version.yml and release-plugin.yml workflows are present under .github/workflows/, so the new automated version bump step will work as intended. This replaces the manual PHP script for bumping versions and updating the changelog, reducing errors and ensuring consistency.

  • File: .github/ISSUE_TEMPLATE/release-template.md (lines 36–37)

@acicovic acicovic merged commit 40ada37 into develop Apr 22, 2025
41 checks passed
@acicovic acicovic deleted the remove/outdated-github-release-issue-template branch April 22, 2025 12:53
github-actions bot added a commit that referenced this pull request Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Maintenance & Fixes Ticket/PR related to codebase maintenance tasks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant