Build Rails and run linters #1078

aparna-ravindra · 2021-09-07T04:57:53Z

This workflow will download a prebuilt Ruby version, install dependencies and run linters.

Tasks

For all workflows, the workflow:

Should be contained in a .yml file with the language or platform as its filename, in lower, kebab-cased format (for example, docker-image.yml). Special characters should be removed or replaced with words as appropriate (for example, "dotnet" instead of ".NET").
Should use sentence case for the names of workflows and steps (for example, "Run tests").
Should be named only by the name of the language or platform (for example, "Go", not "Go CI" or "Go Build").
Should include comments in the workflow for any parts that are not obvious or could use clarification.

For CI workflows, the workflow:

Should be preserved under the ci directory.
Should include a matching ci/properties/*.properties.json file (for example, ci/properties/docker-publish.properties.json).
Should run on push to branches: [ $default-branch ] and pull_request to branches: [ $default-branch ].
Packaging workflows should run on release with types: [ created ].
Publishing workflows should have a filename that is the name of the language or platform, in lower case, followed by "-publish" (for example, docker-publish.yml).

Some general notes:

This workflow must only use actions that are produced by GitHub, in the actions organization, or
This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be published to the GitHub Marketplace. We require that these actions be referenced using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file:
```
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
```
Automation and CI workflows should not send data to any 3rd party service except for the purposes of installing dependencies.
Automation and CI workflows cannot be dependent on a paid service or product.

ashwinsangem · 2021-09-07T05:19:31Z

ci/properties/rails-lint.properties.json

@@ -0,0 +1,6 @@
+{
+    "name": "Rails - Build and Run Linter",


You can use linters(plural) everywhere to be consistent.

bishal-pdMSFT · 2021-09-07T06:29:34Z

ci/rails-lint.yml

+        uses: actions/checkout@v2
+
+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1


This will install gems as well? Which file will it use for gemfile? Do we need to detect that?

It picks Gemfile from the current working directory.
Doc: https://github.com/ruby/setup-ruby#bundler

bishal-pdMSFT · 2021-09-07T06:34:23Z

ci/rails-lint.yml

+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true


What does this do?

this runs 'bundle install' and caches installed gems automatically.
Doc: https://github.com/ruby/setup-ruby

NinadKavimandan · 2021-09-07T08:02:07Z

ci/properties/rails-lint.properties.json

+    "name": "Rails - Build and Run Linters",
+    "description": "Build Rails application and run linters",
+    "iconName": "ruby",
+    "categories": ["Ruby", "Rails"]


we are not detecting Rails in scout yet, so make sure to follow this nomenclature once we add support in scout

@NinadKavimandan @aparna-ravindra wouldn’t it be better to add Rails detection to Scout now itself? Or are you planning that at a later point in time?

Yes, I am working on it. Will raise a PR asap.

NinadKavimandan · 2021-09-07T08:12:56Z

ci/rails-lint.yml

+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby and install gems


In the existing ruby template - https://github.com/actions/starter-workflows/blob/main/ci/ruby.yml, we are using a matrix of different ruby versions. Should we do the same?

I was wondering that. But if the project mentions a particular Ruby version in the Gem file, then the workflow will fail with errors like:
Your Ruby version is 3.0.2, but your Gemfile specified 2.7.2. Hence chose not to use version matrix strategy.

Fair enough

NinadKavimandan · 2021-09-07T09:16:02Z

That's a lot of commits @aparna-ravindra, can we reduce it a bit?

NinadKavimandan

LGTM 👍

Serge2703

ci/rails-lint.yml

Serge2703 · 2021-09-07T22:45:06Z

Testing templates

Serge2703

Bundler-cache/ruby

Serge2703

Duplicate of #

Serge2703

ci/rails-lint.yml

bishal-pdMSFT · 2021-09-08T04:29:47Z

That's a lot of commits @aparna-ravindra, can we reduce it a bit?

Best is to do the squash commit, it will take only one commit to master

joshmgross

For security reasons, we shouldn't pin third party actions to tags or branches. It's preferred to use full commit SHAs, for example:

starter-workflows/ci/ruby.yml

Lines 27 to 30 in 29e8b6c

    
           # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby, 
        
           # change this to (see https://github.com/ruby/setup-ruby#versioning): 
        
           # uses: ruby/setup-ruby@v1 
        
             uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e

joshmgross · 2021-09-08T15:05:20Z

ci/rails-lint.yml

+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies, and  run linters
+name: Build Rails and run linters


👋 There's no "Building" for Rails, should this just be "Run linters"?

@joshmgross Thanks for the inputs. I will raise another PR to incorporate these.

@joshmgross Addressed your inputs in this PR -> #1086

* Secure workflows (#1) (#1072) * Restrict permissions for the GITHUB_TOKEN in .github/workflows/label-feature.yml * Restrict permissions for the GITHUB_TOKEN in .github/workflows/label-support.yml * Restrict permissions for the GITHUB_TOKEN in .github/workflows/stale.yml * Restrict permissions for the GITHUB_TOKEN in .github/workflows/sync_ghes.yaml * Restrict permissions for the GITHUB_TOKEN in .github/workflows/validate-data.yaml Co-authored-by: Step Security <bot@stepsecurity.io> Co-authored-by: step-security[bot] <89328102+step-security[bot]@users.noreply.github.com> Co-authored-by: Step Security <bot@stepsecurity.io> * Directory for deployments (#1071) * moving deployment templates * including deployment directory in scripts * validate categories script init * introducing scout * introducing workflow * Update validate-categories.yaml * Update validate-categories.yaml * Update validate-categories.yaml * Update validate.rb * Update validate.rb * Update validate.rb * Update validate.rb * Update validate-categories.yaml * Update validate-categories.yaml * Update validate-categories.yaml * Update validate.rb * Update validate-categories.yaml * Update validate-categories.yaml * Create test_comment.yaml * rename * using [enter] * testing newline * test * setting up variable * using echo -e * using join * testing space space new line * setting multi line in echo * removing checkout * setting rows-generator * fixing error * using join * commit * Update test_comment.yaml * escaping pipe * printing debug line * using %0A * Update validate-categories.yaml * Update validate.rb * Update validate.rb * removing debug * removing variable * Update validate.rb * Update validate-categories.yaml * Validate categories comment on pr (#32) * reverting deployment directory * checking for output * Categories validation two workflows (#34) comment on pr in a separate workflow * Categories validation two workflows (#35) using right dir name * Categories validation two workflows (#36) . * Categories validation two workflows (#37) fixing typo * adding if conditions * adding try catch * using console instead of echo * equating to upstream * moving deployment templates * add codeql workflow to ghes * restoring from main (#1078) * Revert "add codeql workflow to ghes branch" * add codeql workflow to ghes * only run ghes sync checks on YML files * only check nwo of supported actions * Testing Partner Toggle. Co-authored-by: Varun Sharma <varunsh@stepsecurity.io> Co-authored-by: step-security[bot] <89328102+step-security[bot]@users.noreply.github.com> Co-authored-by: Step Security <bot@stepsecurity.io> Co-authored-by: Aparna Ravindra <82894348+aparna-ravindra@users.noreply.github.com> Co-authored-by: Nick Fyson <nickfyson@github.com>

* Secure workflows (#1) (#1072) * Restrict permissions for the GITHUB_TOKEN in .github/workflows/label-feature.yml * Restrict permissions for the GITHUB_TOKEN in .github/workflows/label-support.yml * Restrict permissions for the GITHUB_TOKEN in .github/workflows/stale.yml * Restrict permissions for the GITHUB_TOKEN in .github/workflows/sync_ghes.yaml * Restrict permissions for the GITHUB_TOKEN in .github/workflows/validate-data.yaml Co-authored-by: Step Security <bot@stepsecurity.io> Co-authored-by: step-security[bot] <89328102+step-security[bot]@users.noreply.github.com> Co-authored-by: Step Security <bot@stepsecurity.io> * Directory for deployments (#1071) * moving deployment templates * including deployment directory in scripts * validate categories script init * introducing scout * introducing workflow * Update validate-categories.yaml * Update validate-categories.yaml * Update validate-categories.yaml * Update validate.rb * Update validate.rb * Update validate.rb * Update validate.rb * Update validate-categories.yaml * Update validate-categories.yaml * Update validate-categories.yaml * Update validate.rb * Update validate-categories.yaml * Update validate-categories.yaml * Create test_comment.yaml * rename * using [enter] * testing newline * test * setting up variable * using echo -e * using join * testing space space new line * setting multi line in echo * removing checkout * setting rows-generator * fixing error * using join * commit * Update test_comment.yaml * escaping pipe * printing debug line * using %0A * Update validate-categories.yaml * Update validate.rb * Update validate.rb * removing debug * removing variable * Update validate.rb * Update validate-categories.yaml * Validate categories comment on pr (#32) * reverting deployment directory * checking for output * Categories validation two workflows (#34) comment on pr in a separate workflow * Categories validation two workflows (#35) using right dir name * Categories validation two workflows (#36) . * Categories validation two workflows (#37) fixing typo * adding if conditions * adding try catch * using console instead of echo * equating to upstream * moving deployment templates * add codeql workflow to ghes * restoring from main (#1078) * Revert "add codeql workflow to ghes branch" * add codeql workflow to ghes * only run ghes sync checks on YML files * only check nwo of supported actions * added `React` and `Angular` as categories to node (#1084) * Fixed a broken link to actions/upload-a-build-artifact in dotnet-desktop.yml. (#1074) Co-authored-by: Josh Gross <joshmgross@github.com> * Added support for Java Frameworks, Spring and JSF to CI Templates. (#1087) * Update OpenShift workflow to use GHCR by default (#6) - Simplifies required configuration since a registry account is now optional - Update a variety of comments - Use tools-installer to install oc - Other small changes towards a better UX Signed-off-by: Tim Etchells <tetchel@gmail.com> * Update github-script major version Co-authored-by: John Bohannon <imjohnbo@github.com> * Addressing review comments - Renaming template and updating setup-ruby action version (#1086) * renaming template and updating setup-ruby action version * renaming rubyrails files * renaming rails files * Addition to categories to python templates (#1088) * addition to categories for python-app template * adding categories to pylint template * adding categories to python-package template Co-authored-by: Ashwin Sangem <ashwinsangem@github.com> * Adding category in the template property file (#1092) * adding category in the template property file * added category on ruby template * add `makefile` template (#1093) Co-authored-by: Ashwin Sangem <ashwinsangem@github.com> * added prefix `npm-` (#1097) * support `AspNetCore` and `DotNetConsole` (#1096) Co-authored-by: Ashwin Sangem <ashwinsangem@github.com> * add `Continuous integration` to makefile props (#1100) Co-authored-by: Varun Sharma <varunsh@stepsecurity.io> Co-authored-by: step-security[bot] <89328102+step-security[bot]@users.noreply.github.com> Co-authored-by: Step Security <bot@stepsecurity.io> Co-authored-by: Aparna Ravindra <82894348+aparna-ravindra@users.noreply.github.com> Co-authored-by: Nick Fyson <nickfyson@github.com> Co-authored-by: Ninad Kavimandan <ninadkavimandan@github.com> Co-authored-by: tmash06 <tmash06@gmail.com> Co-authored-by: Josh Gross <joshmgross@github.com> Co-authored-by: Tim Etchells <tetchel@gmail.com> Co-authored-by: Tim Etchells <tetchell@redhat.com> Co-authored-by: John Bohannon <imjohnbo@github.com> Co-authored-by: Shubham Tiwari <64764738+tiwarishub@users.noreply.github.com>

aparna-ravindra requested a review from a team as a code owner September 7, 2021 04:57

ashwinsangem reviewed Sep 7, 2021

View reviewed changes

bishal-pdMSFT reviewed Sep 7, 2021

View reviewed changes

NinadKavimandan reviewed Sep 7, 2021

View reviewed changes

restoring from main

e84140d

NinadKavimandan approved these changes Sep 7, 2021

View reviewed changes

Serge2703 approved these changes Sep 7, 2021

View reviewed changes

Serge2703 suggested changes Sep 7, 2021

View reviewed changes

Serge2703 reviewed Sep 7, 2021

View reviewed changes

Serge2703 approved these changes Sep 7, 2021

View reviewed changes

bishal-pdMSFT approved these changes Sep 8, 2021

View reviewed changes

ashwinsangem merged commit 237e773 into actions:main Sep 8, 2021

joshmgross reviewed Sep 8, 2021

View reviewed changes

aparna-ravindra mentioned this pull request Sep 13, 2021

Addressing review comments - Renaming template and updating setup-ruby action version #1086

Merged

aparna-ravindra deleted the rails-linter branch September 15, 2021 05:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build Rails and run linters #1078

Build Rails and run linters #1078

aparna-ravindra commented Sep 7, 2021

ashwinsangem Sep 7, 2021

bishal-pdMSFT Sep 7, 2021

aparna-ravindra Sep 7, 2021 •

edited

Loading

bishal-pdMSFT Sep 7, 2021

aparna-ravindra Sep 7, 2021

NinadKavimandan Sep 7, 2021

bishal-pdMSFT Sep 8, 2021

aparna-ravindra Sep 8, 2021

NinadKavimandan Sep 7, 2021

aparna-ravindra Sep 7, 2021

NinadKavimandan Sep 7, 2021

NinadKavimandan commented Sep 7, 2021

NinadKavimandan left a comment

Serge2703 left a comment

Serge2703 commented Sep 7, 2021

Serge2703 left a comment

Serge2703 left a comment

Serge2703 left a comment

bishal-pdMSFT commented Sep 8, 2021

joshmgross left a comment

joshmgross Sep 8, 2021

aparna-ravindra Sep 9, 2021

aparna-ravindra Sep 13, 2021

	# To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
	# change this to (see https://github.com/ruby/setup-ruby#versioning):
	# uses: ruby/setup-ruby@v1
	uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e

Build Rails and run linters #1078

Build Rails and run linters #1078

Conversation

aparna-ravindra commented Sep 7, 2021

Tasks

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aparna-ravindra Sep 7, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NinadKavimandan commented Sep 7, 2021

NinadKavimandan left a comment

Choose a reason for hiding this comment

Serge2703 left a comment

Choose a reason for hiding this comment

Serge2703 commented Sep 7, 2021

Serge2703 left a comment

Choose a reason for hiding this comment

Serge2703 left a comment

Choose a reason for hiding this comment

Serge2703 left a comment

Choose a reason for hiding this comment

bishal-pdMSFT commented Sep 8, 2021

joshmgross left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aparna-ravindra Sep 7, 2021 •

edited

Loading