docs: fix typos and add GitHub Actions usage example to README - #46
Merged
xakep666 merged 2 commits intoJul 3, 2026
Merged
Conversation
Collaborator
|
@FanatiooN thanks for contribution. I have a question: did you try to run github actions workflow provided in example? Or even measure: is it faster than caching provided by setup-go action. Also please reabase to latest main. |
xakep666
reviewed
Jul 2, 2026
FanatiooN
force-pushed
the
docs/readme-typos-and-gha-example
branch
from
July 2, 2026 21:26
d76965d to
717162c
Compare
xakep666
approved these changes
Jul 3, 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
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.
Description
Documentation-only changes to
README.md:enviroments→environments,Coniguration→Configuration,cachprog→cacheprog(3 occurrences),coexistance→coexistence,and one grammar fix (
compiling may it will generate→compiling it will generate).## Usage. The existing examplescover GitLab and Dockerfile
RUN, but not GitHub Actions, which is a commonsetup. The example uses
directmode + S3 and pulls the prebuilt binary fromghcr.io/platacard/cacheprog(nogo install), matching the recommendationalready in the Installation section. It also sets
cache: falseonsetup-gosoGOCACHEisn't archived twice.No source, workflow, or config changes.
TODOs
Read the Contribution guidelines.
Unreleasedsection. — N/A, docs changes are excluded from release notes.Release Notes (draft)
Docs: fixed typos in README and added a GitHub Actions usage example.
Migration Guide
N/A — documentation-only change, no behavior or API affected.