Add deployment workflows and rework README #14
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @westonruter, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on enhancing the project's operational efficiency and user understanding. It introduces automated release tooling to streamline future deployments and significantly improves the project's documentation, making the plugin's functionality, installation, and underlying technical details much clearer to users and contributors.
Highlights
- Deployment Workflows: New GitHub Actions workflow configuration (
.github/release.yml) has been added for automated release changelog generation, excluding Dependabot authors. The.gitignorefile was updated to exclude thedist/directory, anticipating build artifacts from these new workflows. - Documentation Rework: The
README.mdhas been significantly expanded and reorganized. The description now provides a more detailed explanation of the plugin's purpose, the technical nuances ofCache-Controlheaders (no-storevs.private), and the privacy safeguards implemented for bfcache invalidation. Installation instructions have been clarified, and new FAQ sections address common questions related to WordPress core tickets, closed tabs, and Chrome's bfcache behavior withno-store. - Changelog Updates: The
README.mdchangelog now includes an 'Unreleased' section, detailing recent feature additions and fixes, indicating ongoing development and preparation for a new version. - Code Comment Update: A minor comment in
includes/bfcache-opt-in.phpwas updated to reflect that a previously proposed fix in WooCommerce regarding theprivatedirective inCache-Controlheaders has now been merged into WooCommerce v10.1.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a GitHub Actions workflow for releases, updates the .gitignore file, and significantly reworks the README.md to be more comprehensive and better structured. The changes improve the project's documentation and automation.
No description provided.