docs: refresh README for v3 and animate the workflow graph#35
Merged
Conversation
Replace the static run-graph screenshot with an animated GIF showing the three jobs progressing (start runner -> do the job -> stop runner). Complete the inputs table with the inputs added since v2 (ec2-image-filters, ec2-image-owner, eip-allocation-id, runner-version, http-tokens, encrypt-ebs, debug) and update the example to namecheap/ec2-github-runner@v3 and aws-actions/configure-aws-credentials@v4. Signed-off-by: Yuriy R <22548029+kurok@users.noreply.github.com>
dm1tr1yvovk
approved these changes
Jun 9, 2026
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
2 participants
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.
What
docs/images/github-actions-summary.pngwith a looping GIF (github-actions-runner.gif) showing the three jobs progressing: Start self-hosted EC2 runner → Do the job → Stop self-hosted EC2 runner (queued → amber spinner → green ✓ with durations). It's a faithful re-render of GitHub's run-graph in the same light theme as the original screenshot.ec2-image-filters,ec2-image-owner,eip-allocation-id,runner-version,http-tokens,encrypt-ebs,debug. Clarifies thatec2-image-idis required forstartmode only whenec2-image-filtersisn't set.machulav/ec2-github-runner@v2→namecheap/ec2-github-runner@v3, andaws-actions/configure-aws-credentials@v1→@v4.Scope
Docs + image asset only — no
src/,dist/, or dependency changes, so lint / unit tests /verify-distare unaffected.Note
The GIF is a rendered recreation of the Actions run-graph (the original PNG was a captured screenshot). Generated from SVG frames; ~54 KB, 1000×200, loops.