docs icon indicating copy to clipboard operation
docs copied to clipboard

Update building-and-testing-ruby.md

Open qhartman opened this issue 2 years ago â€ĸ 4 comments

Why:

Changing to use action version v1 as recommended at https://github.com/ruby/setup-ruby so that current versions of ruby will be supported rather than falling out of date by pinning to a particular hash.

What's being changed (if available, include any code snippets, screenshots, or gifs):

Just updating the pinned version of the action

Check off the following:

  • [ ] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • [x] For content changes, I have completed the self-review checklist.

qhartman avatar Jun 29 '23 13:06 qhartman

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Jun 29 '23 13:06 welcome[bot]

Automatically generated comment â„šī¸

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/automating-builds-and-tests/building-and-testing-ruby.md fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae
fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar Jun 29 '23 13:06 github-actions[bot]

Was not able to review in the preview env as the deploy there seems to have failed, presumably I don't have permissions to do that. Quite a small change though, so I'm confident it's correct.

qhartman avatar Jun 29 '23 14:06 qhartman

@qhartman Thanks so much for opening a PR! I'll get this triaged for review :zap:

And welcome to the community! 🎉

cmwilson21 avatar Jun 30 '23 03:06 cmwilson21

OK, I was able to verify my change at https://docs-26345-268525.preview.ghdocs.com/en/actions/automating-builds-and-tests/building-and-testing-ruby once you got the deploy through. Thanks @cmwilson21 , I think this is ready to go once it has approval.

qhartman avatar Jul 06 '23 13:07 qhartman

@qhartman Thanks for verifying! It's up on the board waiting review 👀 👍

cmwilson21 avatar Jul 06 '23 14:07 cmwilson21

@SiaraMist Thanks for the review and suggestion. It seems your example and style-guide recommendations are in conflict with those of the authors of the Ruby Action, per the note at https://github.com/ruby/setup-ruby. Perhaps an additional note here with the caveats they mention and/or at least a callout that they make a different recommendation would be helpful for newcomers.

qhartman avatar Aug 15 '23 15:08 qhartman

That makes sense, @qhartman. Going back to read the article, I do notice there is a code comment in the example action that describes this. I linked to the specific line in your PR which isn't actually readable, but you can see the comment displayed in the example in this section.

In light of that comment and the instructions to update the commit SHA, I'm actually going to close this PR instead of updating the SHA in each example on that page so they all match. 👍

SiaraMist avatar Aug 15 '23 22:08 SiaraMist