{"id":34744625,"url":"https://github.com/stellarwp/stellar-changelog-embed","last_synced_at":"2026-05-28T07:32:16.847Z","repository":{"id":283913765,"uuid":"866791943","full_name":"stellarwp/stellar-changelog-embed","owner":"stellarwp","description":"A block that displays the contents of a changelog file from a user-specified URL.","archived":false,"fork":false,"pushed_at":"2025-11-04T19:39:43.000Z","size":423,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-11-04T21:21:52.877Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stellarwp.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.txt","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-10-02T22:05:03.000Z","updated_at":"2025-11-04T19:39:05.000Z","dependencies_parsed_at":"2025-03-23T01:36:51.621Z","dependency_job_id":"bd8a3124-4964-413a-b6b3-350cdcc1da7d","html_url":"https://github.com/stellarwp/stellar-changelog-embed","commit_stats":null,"previous_names":["stellarwp/stellar-changelog-embed"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/stellarwp/stellar-changelog-embed","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellarwp%2Fstellar-changelog-embed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellarwp%2Fstellar-changelog-embed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellarwp%2Fstellar-changelog-embed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellarwp%2Fstellar-changelog-embed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stellarwp","download_url":"https://codeload.github.com/stellarwp/stellar-changelog-embed/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellarwp%2Fstellar-changelog-embed/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33599465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-28T02:00:06.440Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-25T04:29:56.214Z","updated_at":"2026-05-28T07:32:16.842Z","avatar_url":"https://github.com/stellarwp.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StellarWP Changelog Embed\n\nA WordPress plugin that allows you to display changelogs from your GitHub repositories in a clean, organized format using a Gutenberg block.\n\n## Features\n\n- Connects to GitHub to fetch changelog.txt files directly from your repositories\n- Parses WordPress plugin-style changelog entries\n- Displays changelogs in an expandable/collapsible interface\n- Groups changes by type (Fix, Feature, Tweak, Security, etc.)\n- Caches GitHub API responses to improve performance\n- Full Gutenberg block integration with live preview\n- Responsive design that works on all devices\n- Preserves user preferences for expanded/collapsed versions\n\n## Installation\n\n1. Upload the `stellar-changelog-embed` folder to the `/wp-content/plugins/` directory\n2. Activate the plugin through the 'Plugins' menu in WordPress\n3. Add a StellarWP Changelog Embed block to any post or page\n\n## Usage\n\n### Using the Block\n\n1. Add a \"StellarWP Changelog Embed\" block to your post or page\n2. In the block settings, enter:\n   - Repository Owner (GitHub username or organization)\n   - Repository Name\n   - Changelog File Path (defaults to \"changelog.txt\")\n   - Branch (defaults to \"main\")\n   - Maximum Versions to display\n3. Save your post or page\n\n### GitHub API Configuration\n\nTo avoid GitHub API rate limits or to access private repositories:\n\n1. Go to Settings \u003e StellarWP Changelog Embed\n2. Enter your GitHub Personal Access Token\n3. Save Changes\n\n## Changelog Format\n\nThe plugin expects changelog files in this format:\n\n```\n= [4.21.1 2025-08-07] =\n* Fix - Fixed missing quiz points in the activity report widget.\n* Tweak - Improved the UX of the quiz template saving process.\n* Feature - Added new functionality for users.\n* Security - Fixed potential vulnerability in the login system.\n\n= [4.21.0 2025-07-01] =\n* Feature - Added new quiz statistics visualization tools.\n* Fix - Resolved an issue with the course progress not updating correctly.\n...\n```\n\n## Development\n\nFor detailed implementation instructions, customization options, and technical details, see the [Implementation Guide](IMPLEMENTATION-GUIDE.md).\n\n### Key Components\n\n- **plugin.php**: Main plugin file\n- **class-github-api.php**: Handles GitHub API integration and caching\n- **class-changelog-parser.php**: Parses changelog text into structured data\n- **class-settings.php**: Manages plugin settings and admin interface\n- **class-api.php**: Registers REST API endpoints\n- **index.js**: Block editor implementation\n- **frontend.js**: Frontend interaction handling\n- **src/views/changelog.php**: View template for rendering the changelog (uses BEM CSS classes)\n\n### Building the JavaScript\n\nThis plugin uses @wordpress/scripts for building:\n\n1. Install dependencies: `npm install`\n2. Development build with watch mode: `npm start`\n3. Production build: `npm run build`\n\n## Customization\n\n### CSS Customization\n\nThe plugin includes styling that should work with most themes. The CSS uses BEM methodology with the `stellar-changelog-embed` block. If you need to customize the appearance, you can:\n\n1. Add custom CSS to your theme targeting the BEM classes:\n   ```css\n   .stellar-changelog-embed__version-header {\n       /* Custom styles for version headers */\n   }\n   \n   .stellar-changelog-embed__section[data-type=\"Feature\"] {\n       /* Custom styles for feature sections */\n   }\n   ```\n2. Or edit the `assets/css/changelog-viewer.css` file directly\n\n### Template Customization\n\nTo customize the HTML output:\n\n1. Copy `src/views/changelog.php` to your theme folder under `my-theme/stellar-changelog-embed/changelog.php`\n2. Edit the template as needed. The template uses BEM CSS classes for styling:\n   - Main container: `stellar-changelog-embed`\n   - Elements: `stellar-changelog-embed__element`\n   - Modifiers: `stellar-changelog-embed__element--modifier`\n\n## Troubleshooting\n\n- **GitHub API Rate Limit**: If you see errors about rate limits, add a GitHub Personal Access Token in the plugin settings\n- **No Changelog Data**: Verify your repository details and ensure the changelog file exists at the specified path\n- **Parse Errors**: Check that your changelog follows the expected format\n\n## Credits\n\n- Built by Your Name\n- Inspired by the React component provided as a reference\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstellarwp%2Fstellar-changelog-embed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstellarwp%2Fstellar-changelog-embed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstellarwp%2Fstellar-changelog-embed/lists"}