-
Notifications
You must be signed in to change notification settings - Fork 2.6k
ci: refresh contrib.rocks cache workflow #8083
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
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.
Pull Request Overview
This PR rewrites the GitHub workflow from updating contributors to refreshing contrib.rocks image cache by bumping the cacheBust parameter. It simplifies the workflow by removing Node.js setup and contributor update logic, and moves permissions to the workflow level.
- Removes push trigger and contributor update functionality
- Adds explicit workflow-level permissions for contents and pull-requests
- Replaces complex contributor update with simple timestamp-based cacheBust parameter update
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
Thank you for your contribution! I've reviewed the changes and found critical issues that need attention before this workflow can function properly.
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.
Is this intentional? The workflow filename is still update-contributors.yml but its purpose has completely changed to refreshing contrib.rocks cache. Should we rename this file to something like refresh-contrib-cache.yml to better reflect its new purpose?
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.
Minor style suggestion: The inline comment after the workflow name is unconventional. Consider either removing it or moving it to a separate comment line:
| name: Update Contributors # Refresh contrib.rocks image cache | |
| name: Refresh Contrib.rocks Cache | |
| # Refreshes the contrib.rocks image cache by updating cacheBust parameter |
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.
Critical Issue: This workflow will fail because the cacheBust parameter doesn't exist in README.md. I checked the current README.md and there's no cacheBust= parameter to update. The workflow will exit with code 1 and the error message "cacheBust parameter not found in README.md".
Additionally, the README.md doesn't contain any contrib.rocks image or reference. Before this workflow can work, we need to:
- Add a contrib.rocks image to the README.md
- Include the cacheBust parameter in the image URL
Example:
Rewrite workflow to bump README cacheBust and open PR only when changed; add explicit permissions and simplify steps.
3336351 to
634602f
Compare
Bump cacheBust in README.md and locales/*/README.md; PR auto-created only when changes detected.
Relates to #8005
Rewrite workflow to bump README cacheBust and open PR only when changed; add explicit permissions and simplify steps.
Important
Updates GitHub Actions workflow to refresh contrib.rocks cache by modifying
cacheBustin README files and creating a PR only if changes occur.refresh-contrib-cacheinupdate-contributors.yml.contentsandpull-requests.cacheBustparameter inREADME.mdandlocales/*/README.md.refresh-contrib-cachefor pull requests.This description was created by
for be7e765. You can customize this summary. It will automatically update as commits are pushed.