Skip to content

Initial Release

Choose a tag to compare

View all tags
@mljlynch mljlynch released this 23 Mar 18:46
· 19 commits to main since this release
v1.0.0
1dba385

Release Notes: PR Image Width Adjuster v1.0.0

🚀 Initial Release

We're excited to introduce the PR Image Width Adjuster GitHub Action! This action automatically converts markdown images in pull request descriptions to HTML <img> tags with specified width attributes, providing better control over image display without physically resizing images.

✨ Features

  • Markdown to HTML conversion: Automatically detects markdown image syntax (![alt](url)) in PR descriptions and converts them to HTML <img> tags
  • Width control: Adds a configurable width attribute to all images (defaults to 300px)
  • Alt text preservation: Maintains the original alt text from markdown images
  • Zero image manipulation: Controls display size without downloading or modifying the original images
  • Lightweight: Minimal dependencies, fast execution

🛠️ Configuration Options

  • token: GitHub token for API access (Required)
  • width: Target width for images in pixels (Optional, defaults to 300)

📋 Usage Example

name: Adjust Image Widths

on:
  pull_request:
    types: [opened, edited, synchronize]

jobs:
  adjust-image-widths:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
      
      - name: Adjust image widths in PR description
        uses: your-username/pr-image-width-adjuster@v1.0.0
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          width: 500  # Optional, defaults to 300px

🧪 Testing

This release includes comprehensive test coverage to ensure reliable operation in various scenarios.

🔮 Future Plans

  • Support for additional image formats
  • Option to specify different widths for different image types
  • Support for other HTML attributes

We welcome your feedback and contributions!

Assets 2
Loading