opensearch-project/OpenSearch

Create a Github Action to ensure variables in shell scripts are set

Open

#3,343 opened on May 16, 2022

View on GitHub
 (10 comments) (1 reaction) (1 assignee)Java (1,505 forks)batch import
BuildBuild Libraries & Interfacesenhancementgood first issue

Repository metrics

Stars
 (8,123 stars)
PR merge metrics
 (Avg merge 5d 9h) (266 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe. Coming from https://github.com/opensearch-project/OpenSearch/issues/3106 and https://github.com/opensearch-project/OpenSearch/pull/3278#issuecomment-1127698467. Create a Github Action to run on pull request to ensure whether shell scripts variables are set.

Describe the solution you'd like Can use https://github.com/marketplace/actions/shellcheck for the same.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

Contributor guide

Research direction
Set up a GitHub Action using ShellCheck to check shell scripts for unset variables. Follow the linked discussion for details.
Tech stack
shellgithub actions
Domain
devopsci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70