Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

The GitHub Action docs omit the install-from-source input added in #361

Open Beginner friendly
  • Is something wrong?
#369 2 comments 0 reactions 1 assignee View on GitHub

Maintainers usually reply within 1 day

@vally111 is already working on this.

Since Oct 15, 2026.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
86/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
bash, github-actions
Domain
ci-cd, documentation

Research direction

Start with the install-from-source declaration in .github/actions/sdkt/action.yml and the five ::error:: lines that point to it, then copy the existing row format from the ## Inputs table in docs/compatibility/ci-cd.md. Add the same row, in declaration order, to the matching table in docs/compatibility/README.md. Done when both tables list all 15 inputs and the diff command in the issue shows no difference, with the other 14 rows unchanged.

Written by the indexing model from the issue text.

Description

documentation Stellar Wave

Context

.github/actions/sdkt/action.yml is the reusable composite Action that external consumers install sdkt through. Its input set is documented in two places: docs/compatibility/ci-cd.md and docs/compatibility/README.md (both carry an ## Inputs table).

Problem

Verified against origin/main (9c3af449).

PR #361 (b6e0b27d, merged 2026-10-13) added a new input to the Action:

# .github/actions/sdkt/action.yml
  install-from-source:

The Action now declares 15 inputs; the documented tables list 14. install-from-source is the only one missing from both docs/compatibility/ci-cd.md and docs/compatibility/README.md.

The omission is not cosmetic. The input is the documented escape hatch for every install failure the new prebuilt-binary path can produce — the Action's own error messages point at it:

action.yml:107   ::error::unsupported runner kernel: $(uname -s). Set install-from-source: true.
action.yml:116   ::error::no prebuilt asset for $OS/$ARCH. Set install-from-source: true.
action.yml:128   ::error::release asset $ASSET not found for $SDKT_VERSION. Older tags predate some platforms; set install-from-source: true.
action.yml:150   ::error::no checksum available for $ASSET; refusing to install an unverified binary. Set install-from-source: true.
action.yml:159   ::error::no sha256 tool available (sha256sum/shasum). Set install-from-source: true.

A consumer hitting any of those five errors reads the Action's guidance, turns to the documented input table, and does not find the flag it is being told to set. The PR that introduced the input changed only action.yml and sdkt-action-ci.yml — no documentation file.

Contributor Task

Document the input in both tables:

  1. Add an install-from-source row to the ## Inputs table in docs/compatibility/ci-cd.md, with its default, its meaning (build sdkt from the pinned git tag instead of downloading the prebuilt release asset), and the failure cases it resolves.
  2. Add the same row to the identical table in docs/compatibility/README.md.
  3. Keep the row ordering consistent with action.yml's declaration order so the two stay comparable.
  4. Do not change the Action's behavior or the other rows' text.

Deliverables

  • docs/compatibility/ci-cd.md: the new input row.
  • docs/compatibility/README.md: the new input row.

Dependencies

None.

Acceptance Criteria

  • Both tables list install-from-source with a default and a meaning.
  • The row states that the Action builds from the pinned git tag when the input is true.
  • The row names the failure cases the input resolves (unsupported kernel, missing prebuilt asset, missing checksum, missing sha256 tool).
  • The other 14 rows are unchanged.
  • The documented input set matches action.yml exactly.

Verification

grep -A2 'install-from-source:' .github/actions/sdkt/action.yml | head -6
grep -n 'install-from-source' docs/compatibility/ci-cd.md docs/compatibility/README.md
# compare the two sets:
diff <(grep -oE '^  [a-z-]+:' .github/actions/sdkt/action.yml | tr -d ' :') \
     <(grep -oE '^\| `[a-z-]+`' docs/compatibility/ci-cd.md | tr -d '| `')

Proof of Completion

  • The PR includes the diff output of the two input sets before and after, showing they match.

Out of Scope

  • Changing the Action's install logic or its error messages.
  • The Action's audit gate (whether it uses --fail-on or jq).
  • Any other input row.

Non-negotiable Constraints

  • The documented input names must match action.yml exactly.
  • No behavioral change to the Action.

PR Requirements

  • One PR covering both documentation files.
  • The PR description states which input set was compared and how.
Dominant language
Rust
Stars
5
Forks
84
Avg merge
17h 27m
Merged PRs (30d)
111

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SaboLabs/soroban-devkit

All issues in SaboLabs/soroban-devkit

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.