Skip to content

docs: fix typos and add GitHub Actions usage example to README - #46

Merged
xakep666 merged 2 commits into
platacard:mainfrom
FanatiooN:docs/readme-typos-and-gha-example
Jul 3, 2026
Merged

docs: fix typos and add GitHub Actions usage example to README#46
xakep666 merged 2 commits into
platacard:mainfrom
FanatiooN:docs/readme-typos-and-gha-example

Conversation

@FanatiooN

Copy link
Copy Markdown
Contributor

Description

Documentation-only changes to README.md:

  • Fix typos: enviromentsenvironments, ConigurationConfiguration,
    cachprogcacheprog (3 occurrences), coexistancecoexistence,
    and one grammar fix (compiling may it will generatecompiling it will generate).
  • Add a GitHub Actions usage example under ## Usage. The existing examples
    cover GitLab and Dockerfile RUN, but not GitHub Actions, which is a common
    setup. The example uses direct mode + S3 and pulls the prebuilt binary from
    ghcr.io/platacard/cacheprog (no go install), matching the recommendation
    already in the Installation section. It also sets cache: false on
    setup-go so GOCACHE isn't archived twice.

No source, workflow, or config changes.

TODOs

Read the Contribution guidelines.

  • Generate the docs. — N/A, this PR is the docs change.
  • Run the relevant tests successfully. — N/A, no code changes.
  • Include release notes. If this PR is backward incompatible, include a migration guide. — N/A, docs only, not backward-incompatible.
  • Update the CHANGELOG.md file: add a feature / bug fix entry for this PR under Unreleased section. — 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.

@xakep666

xakep666 commented Jul 2, 2026

Copy link
Copy Markdown
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.

Comment thread README.md Outdated
@FanatiooN
FanatiooN force-pushed the docs/readme-typos-and-gha-example branch from d76965d to 717162c Compare July 2, 2026 21:26
@xakep666
xakep666 merged commit ebe6059 into platacard:main Jul 3, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants