docs: add ADR to adopt ShellCheck #60
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kdmccormick
force-pushed
the
kdmccormick/shellcheck
branch
3 times, most recently
from
260f864 to
f00881b
Compare
kdmccormick
changed the title
kdmccormick
commented
Feb 22, 2023
|
A side question: will this help us decide whether shell scripts use 2-space or 4-space indentation? |
Oh no, I've been using tabs 😬 ShellCheck avoids giving any formatting-related advice unfortunately. I've heard good things about shfmt for that, though. I'll give it a try, and might do another ADR if it's good to work with. |
|
I think having some help for developers who are more familiar with python than shell is a great addition to the tooling. +1 |
kdmccormick
added a commit
to openedx/edx-platform
that referenced
this pull request
Feb 22, 2023
Additionally, this brings all existing shell scripts into compliance with ShellCheck. This implements part of an ADR, proposed here: openedx/.github#60
kdmccormick
added a commit
to openedx/edx-platform
that referenced
this pull request
Feb 24, 2023
Additionally, this brings all existing shell scripts into compliance with ShellCheck. This implements part of an ADR, proposed here: openedx/.github#60
feanil
reviewed
Feb 27, 2023
timmc-edx
reviewed
Feb 27, 2023
timmc-edx
reviewed
Feb 27, 2023
timmc-edx
reviewed
Feb 27, 2023
timmc-edx
reviewed
Feb 27, 2023
timmc-edx
reviewed
Feb 27, 2023
kdmccormick
force-pushed
the
kdmccormick/shellcheck
branch
from
6e55c1a to
b23a8e2
Compare
kdmccormick
changed the title
|
In order to keep this PR focused on the ADR, I created a draft PR to discuss the actual implementation of the workflow template and/or shared workflow: #64 |
feanil
reviewed
Feb 28, 2023
Co-authored-by: Feanil Patel <[email protected]>
Co-authored-by: Tim McCormack <[email protected]>
Co-authored-by: Tim McCormack <[email protected]>
Co-authored-by: Tim McCormack <[email protected]>
kdmccormick
commented
Feb 28, 2023
kdmccormick
requested review from
timmc-edx and
feanil
and removed request for
timmc-edx
feanil
approved these changes
Feb 28, 2023
timmc-edx
reviewed
Feb 28, 2023
timmc-edx
approved these changes
Feb 28, 2023
kdmccormick
commented
Mar 1, 2023
kdmccormick
commented
Mar 2, 2023
kdmccormick
added a commit
to openedx/edx-platform
that referenced
this pull request
Mar 2, 2023
Additionally, this brings all existing shell scripts into compliance with ShellCheck. This implements part of an ADR, proposed here: openedx/.github#60
kdmccormick
added a commit
to openedx/edx-platform
that referenced
this pull request
Mar 10, 2023
Additionally, this brings all existing shell scripts into compliance with ShellCheck. This implements part of an ADR, proposed here: openedx/.github#60
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link to rendered ADR
https://github.com/kdmccormick/openedx.github/blob/kdmccormick/shellcheck/docs/decisions/0001-shellcheck.rst
Related Changes
Draft .github PR to implement a shared workflow/template/action:
Draft edx-platform PR, with the ShellCheck workflow in action: