[WIP] Add CI workflow for automatic screenshots generation#24
Merged
Conversation
Contributor
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Copilot stopped work on behalf of
GizzZmo due to an error
March 22, 2026 16:56
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
scripts/generateScreenshots.jsusing Puppeteer to capture screenshots and update READMEimages/directory with a placeholder.gitkeeppuppeteeras a dependency inpackage.jsonand addgenerate:screenshotsnpm scriptREADME.md.github/workflows/screenshots.ymlGitHub Actions workflowOriginal prompt
Create a CI workflow system to automatically generate screenshots for the README file. The workflow should utilize GitHub Actions and include the following steps:
images/).README.mdfile with references to the new screenshots.README.mdand screenshot images.Additionally, include an example script
scripts/generateScreenshots.jsin the repository. This script should:README.mdto reflect the new screenshots using markdown image syntax.Ensure that the
README.mdfile contains the new screenshots under the "Screenshots" section. Provide clear instructions and comments within the files for maintainability.The following is the prior conversation context from the user's chat exploration (may be truncated):
User: Get me started with Git.
Assistant: Getting started with Git is exciting! Here’s a step-by-step guide to help you begin:
1. What is Git?
Git is a version control system that helps you track changes in your code, collaborate with others, and manage your project files efficiently.
2. Install Git
Start by installing Git on your computer:
brew install git(via Homebrew) or download the installer here.sudo apt install git(Ubuntu/Debian) orsudo yum install git(Fedora).3. Set Up Git
Once installed, set up your user information (this will appear on your commits):
4. Initialize a Repository
If you want to start tracking changes on a new project:
mkdir my_project cd my_project git initThis creates a
.gitfolder in your project, initializing it as a Git repository.5. Clone an Existing Repository
If you want to work on an already existing repository, you can clone it:
For example:
6. Track Changes
Add your changes to the staging area:
Commit changes to save a checkpoint:
git commit -m "Your commit message"7. View and Check Changes
See the current status of your repository:
View the commit history:
Compare changes between saved stages:
8. Push to a Remote Repository
After making changes, you can push them to a remote repository like GitHub:
(Replace
mainwith your branch name, if different.)9. Branching and Merging
Create a branch:
Merge a branch into main:
To list all branches:
Additional Resources:
If you have questions about specific steps or commands, I’d be happy to help!
User: ADD screenshots in readme
Assistant: To include screenshots in a
README.mdfile, you'll need to follow these steps:1. Take and Upload Screenshots
First, capture the relevant screenshots of your project and upload them to the GitHub repository. You can upload images by dragging and dropping files into the issue area or directly uploading them to the repository.
2. Reference the Screenshot in the README
Update your
README.mdfile to reference these screenshots using Markdown.The syntax to include images in Markdown is:
For example:
3. Organize the Repository
To organize the images, you can create a new directory called
imagesin your repository:This pull request was created from Copilot chat.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.