Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more guidance on Ruby #372

Merged
merged 3 commits into from
Aug 29, 2023
Merged

Add more guidance on Ruby #372

merged 3 commits into from
Aug 29, 2023

Conversation

gminn
Copy link
Member

@gminn gminn commented Aug 29, 2023

Users can pretty easily run into errors building if the right version of Ruby isn't being used.
This commit adds more guidance on managing Ruby versions, as well as setting up a Python
virtual environment.

To ensure the version of Ruby newly listed in readme.md matches the .ruby-version file,
a GitHub workflow has been added.

The workflow can be tested by running it manually:

gh workflow run detect-ruby-version-mismatch.yml --ref $(git rev-parse --abbrev-ref HEAD)

The workflow was tested by checking for failure when either the readme.md or the
.ruby-version was changed and there was a mismatch. Checked for
success by reverting each change. Results are
here.

Sadly didn't know re-named workflows generate a new workflow and can't
get removed
...so
there is an extra workflow in Actions from when I
renamed the workflow that I've disabled for now.

Copy link
Contributor

@noahp noahp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

.github/workflows/detect-ruby-version-mismatch.yml Outdated Show resolved Hide resolved
Copy link
Member

@mrcljx mrcljx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to move ahead.

Comment on lines +25 to +26
- Python 3.8 or later
- Ruby 2.7.7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lazy me would just have done:

You'll need:

  • Python (see .python-version for version)
  • Ruby (see .ruby-version for version)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair point, but then I wouldn't get to force a workflow to fail, which is fun 😀

@gminn gminn merged commit c297575 into master Aug 29, 2023
5 checks passed
@nihalgonsalves nihalgonsalves deleted the gminn/update-readme branch February 28, 2024 11:31
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.

3 participants