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

Emit all shellcheck errors using github action toolkit annotations and check for tab indentation #658

Merged
merged 3 commits into from
Oct 8, 2024

Conversation

cartercanedy
Copy link
Contributor

@cartercanedy cartercanedy commented Sep 23, 2024

Tabs are problematic when rendering previews of shell scripts, as it results in a disparity between the position of expected rendered characters and where they may actually be rendered on the screen, and having mixed space/tab indentation in the same file is generally problematic as well.

Type of Change

  • Bug fix
  • Refactoring

Description

  • Emit all errors found within the changed files using gh actions toolkit annotations, before, the workflow would fail on the first shellcheck invocation that had an error emission
  • Add a tab indentation check to enforce consistency in code style
  • removed all current tab indentations that I've found in shell scripts

Testing

Verified using workflow runs within my own repository

Impact

Helps provide complete error information from both shellcheck and tab indentation detection

Checklist

  • My code adheres to the coding and style guidelines of the project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no errors/warnings/merge conflicts.

@cartercanedy cartercanedy force-pushed the main branch 2 times, most recently from d13f363 to d508236 Compare September 23, 2024 18:20
@nnyyxxxx
Copy link
Contributor

nnyyxxxx commented Sep 23, 2024

also the browser-setup formatting changes are already implemented in #648 @cartercanedy

@cartercanedy
Copy link
Contributor Author

also the browser-setup formatting changes are already implemented in #648 @cartercanedy

I need those implemented here to pass the new shellcheck ci workflow. You should be able to rebase your changes on top of mine

@cartercanedy cartercanedy force-pushed the main branch 2 times, most recently from 2be5baf to 020d72b Compare September 23, 2024 18:40
@cartercanedy cartercanedy changed the title Emit all shellcheck errors using github action workflow toolkit annotations and check for tab indentation Emit all shellcheck errors using github action toolkit annotations and check for tab indentation Sep 23, 2024
@cartercanedy cartercanedy force-pushed the main branch 2 times, most recently from a7984ae to 10bc9c8 Compare September 24, 2024 16:08
@cartercanedy
Copy link
Contributor Author

@ChrisTitusTech I'd recommend committing this before pulling in any shell scripts to get better shellcheck errors and catch formatting issues

@cartercanedy cartercanedy force-pushed the main branch 5 times, most recently from 81f63a8 to bd2b5a5 Compare October 2, 2024 19:59
@ChrisTitusTech ChrisTitusTech merged commit 64c34f5 into ChrisTitusTech:main Oct 8, 2024
2 checks passed
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