Feat/GitHub pages website#72
Conversation
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThe PR adds a public-facing GitHub Pages site, improves the release process with validation and plugin filtering, implements OpenSSF Scorecard monitoring, excludes site changes from release triggers, and introduces contributor and security documentation alongside an updated README. ChangesGitHub Pages Site Deployment
Release Process & Build Validation
Project Documentation & Security
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes The PR spans multiple independent domains (site deployment, release mechanics, documentation, security workflows) with heterogeneous changes including new configuration logic (plugin filtering), scripting (release-main.mjs), markup (site files), and documentation. While each cohort follows a clear pattern, the diversity of file types and purposes—from CSS styling to workflow YAML to npm scripts—requires separate reasoning for each component. Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 0/1 reviews remaining, refill in 53 minutes and 28 seconds.Comment |
Review Summary by QodoAdd GitHub Pages site, improve release config, and enhance documentation
WalkthroughsDescription• Add GitHub Pages landing site with SEO metadata and styling • Filter changelog and git plugins from repo-only release config • Add GitHub Pages and OpenSSF Scorecard deployment workflows • Restructure README with improved organization and features section • Add CONTRIBUTING.md and SECURITY.md documentation files • Update release workflow to skip site changes and add package check Diagramflowchart LR
A["Release Config"] -- "filter plugins" --> B["Repo Release Config"]
C["Site Files"] -- "deploy via workflow" --> D["GitHub Pages"]
E["CI Workflow"] -- "skip site changes" --> F["Release Workflow"]
G["Documentation"] -- "add guides" --> H["Contributing & Security"]
I["Package"] -- "add homepage" --> J["npm Registry"]
File Changes1. site/index.html
|
Code Review by Qodo
1. Broken npm README image
|
…site # Conflicts: # readme.md # site/index.html # site/styles.css
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
| <p align="center"> | ||
| <img src="./site/assets/icon.svg" width="120" height="120" alt="semantic-release-npm-github-publish icon"> | ||
| </p> |
There was a problem hiding this comment.
1. Broken npm readme image 🐞 Bug ≡ Correctness
readme.md embeds ./site/assets/icon.svg, but package.json’s files allowlist excludes site/**, so the image will be missing from the published package and render broken on npmjs.com and in node_modules.
Agent Prompt
### Issue description
`readme.md` references `./site/assets/icon.svg`, but `site/**` is not included in the npm package allowlist (`package.json.files`). This causes a broken image on npmjs.com and for users viewing the packaged README.
### Issue Context
npm includes the README by default, but it will not include arbitrary referenced assets unless they’re part of the packed files.
### Fix Focus Areas
- readme.md[25-27]
- package.json[27-33]
### Suggested fix options
1) Change the README image URL to an absolute URL (recommended), e.g. to `raw.githubusercontent.com` (or to the GitHub Pages URL).
2) Alternatively, include the needed asset(s) in the npm package by adding `site/assets/icon.svg` (or `site/assets/**`) to `files` (avoid shipping the whole `site/` unless intentional).
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
🎉 This PR is included in version 1.7.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
1 participant
Summary by CodeRabbit
New Features
Documentation
Chores