Skip to content

fix: use Ruby 3.4 for website builds, update documentation - #1544

Open
GitToTheHub wants to merge 4 commits into
masterfrom
fix/ruby-3.4-workflows
Open

GitToTheHub wants to merge 4 commits into
masterfrom
fix/ruby-3.4-workflows

Conversation

@GitToTheHub

@GitToTheHub GitToTheHub commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Platforms affected

Website build and deployment workflows (GitHub Actions).

Motivation and Context

The staging deployment fails during Ruby setup because ubuntu-latest now resolves to Ubuntu 26.04 and Ruby 2.7.8 has no binary for that runner.

Description

  • Use Ruby 3.4 in staging, production, and PR build workflows. Ruby 3.4 has published Ubuntu 26.04 binaries.
  • Update the development setup guide for Ruby 3.4, current Bundler commands, and Node.js 24; remove obsolete Ruby 2.0/2.2 and Python/Pygments instructions.
  • Document the current GitHub Actions deployment process and replace the Travis badge with badges for all four workflows.

Testing

Validated locally on macOS with an isolated Ruby 3.4.9 runtime:

  • Existing locked gems and fresh gem resolution both install successfully.
  • npm ci and npm test pass (Node.js 22.17.1).
  • npm run build and npm run build:prod pass using the freshly resolved gems and Jekyll 4.4.1. Existing Sass deprecation warnings remain.
  • Workflow YAML parsing, local documentation links, and git diff --check pass.

The Ubuntu runner environment has not been exercised locally; GitHub Actions will provide that verification.

Checklist

  • I've run the tests to see all new and existing tests pass
  • I added automated test coverage as appropriate for this change (existing workflow checks cover the runtime change; no new tests needed)
  • Commit is prefixed with (platform) if this change only applies to one platform (not applicable)
  • If this Pull Request resolves an issue, I linked to the issue in the text above (failed workflow linked; no issue to close)
  • I've updated the documentation if necessary

Generative Tooling Disclosure

OpenAI Codex generated the workflow edits, documentation and README/badge changes, and heading corrections in this PR. It also ran the commands reported under Testing. The runtime change was based on the linked failed job and Ruby binary availability; setup instructions were checked against the Homebrew and RubyInstaller documentation.

All commits carry Generated-by: OpenAI Codex (GPT-6.1 Sol) in accordance with the provenance recommendation in the ASF Generative Tooling Guidance. The model used was GPT-6.1 Sol, as confirmed by the contributor; the exact Codex application build was not recorded. The PR description was also drafted using Codex.

Automated validation does not establish human review or certify licensing compliance. The contributor and reviewers remain responsible for evaluating the changes, applicable tool terms, and any third-party material before acceptance under the ASF guidance. This disclosure does not assert that a human review or training-data similarity scan has been completed.

@GitToTheHub GitToTheHub changed the title fix: use Ruby 3.4 for website builds fix: use Ruby 3.4 for website builds, update documentation Oct 27, 2026
@breautek

breautek commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Re: cdd54ac

Capitalization every word under a title isn't really proper in the US English I believe. Minor words (a, the, and, etc) aren't suppose to be capitalized, unless if they are the first or last word of the title, e.g: The Fox and the Hound

https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case for general rules for title capitalization.

@GitToTheHub

GitToTheHub commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor Author

Re: cdd54ac

Capitalization every word under a title isn't really proper in the US English I believe. Minor words (a, the, and, etc) aren't suppose to be capitalized, unless if they are the first or last word of the title, e.g: The Fox and the Hound

https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case for general rules for title capitalization.

I cannot remember correctly but when I saw one time changes on a markdown here on Cordova, the words on a title were changed to be started all uppercased. But I don't know if this was only for nouns or for every word. So is this the right approach for markdown titles, what you wrote?

@breautek

breautek commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

I cannot remember correctly but when I saw one time changes on a markdown here on Cordova, the words on a title were changed to be started all uppercased.

Yah that's not really correct... minor words are not capitalized. General rules for title capitalization:

  • Minor words are not capitalized
  • First word and last word of the title is always capitalized (including minor words if they appear as the first or last word in the title)
  • Pretty much everyhing else is capitalized, including nouns, Pronouns, verbs, adjectives, etc are capitalized.
  • Major words that are Hyphenated words are capitalized on both ends (e.g Self-Report, not Self-report)

Minor words are:

  • short conjunctions ("and", "but", "nor", "or", "if")
  • articles ("a", "an", "the")
  • short prepositions ("as", "at", "for", "to", "in")

Major words are all nouns, verbs, adjectives, pronouns, adverbs. If the word is four letters or more, it's going to be a major word basically and should be capitalized.

None of the above is an exhaustive list, just examples.

The APA style guide is a good source, is what most editorial uses and is probably what we should follow for our documentation, and afaik most of our document already does follow the APA style.

@GitToTheHub

Copy link
Copy Markdown
Contributor Author

Wow Norman, thanks for this very detailed overview of it. It's like a rule book. I will change the titles accordingly. Should we document this somewhere in the Cordova project?

@breautek

Copy link
Copy Markdown
Contributor

Should we document this somewhere in the Cordova project?

Not sure if that is really necessary... APA writing style is pretty standard practice.

@GitToTheHub

Copy link
Copy Markdown
Contributor Author

Ok, I never heard about APA.

@GitToTheHub

Copy link
Copy Markdown
Contributor Author

I created PR #1545 which adds this to https://github.com/apache/cordova-docs/blob/master/doc/docs-STYLEGUIDE.md#structure-and-flow and add a check to the pull request template.

@GitToTheHub

Copy link
Copy Markdown
Contributor Author

Is this PR here good to go?

@GitToTheHub
GitToTheHub force-pushed the fix/ruby-3.4-workflows branch 2 times, most recently from 6ee1506 to 8976cd9 Compare October 29, 2026 13:47
Generated-by: OpenAI Codex (GPT-6.1 Sol)
Generated-by: OpenAI Codex (GPT-6.1 Sol)
Generated-by: OpenAI Codex (GPT-6.1 Sol)
Generated-by: OpenAI Codex (GPT-6.1 Sol)
@GitToTheHub
GitToTheHub force-pushed the fix/ruby-3.4-workflows branch from 8976cd9 to 818fc78 Compare October 29, 2026 13:48
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