devlinjunker / example.cii Goto Github PK

Describe the Improvement:
Should provide examples of using linters, so we can update style guide

• Markdown: https://github.com/markdownlint/markdownlint
• YAML: https://github.com/adrienverge/yamllint

See also devlinjunker/template.github.semver#51

Benefits:

• Ensure that Github Actions do not contain syntax errors

Drawbacks:
Slows build/release process

How to Compare:
Should see reduced number of errors in github action files when merged

Describe the Improvement:
Look into mutation testing via PRs with: https://github.com/tylermurry/github-pr-landmine

Benefits:

• Example of using mutation testing

Drawbacks:

• Effort? Can we even do it with these scripts?

How to Compare:

• Should be able to comment on PRs and do mutation testing if this works

Describe the change:
Add CII Badge to README

Additional context/Links:
https://bestpractices.coreinfrastructure.org/en/projects/new

Describe the change:
Add better notes for cloning vs forking vs using as a template

template:

• best way

cloning:

• should only check out HEAD commit
• Maybe even only main commit

forking

• idk yet..

Additional context/Links:
Problems when using for practice.GitHub.actions repo

Describe the Improvement:
Implement Shell Script Static Checker for this repo: https://github.com/koalaman/shellcheck

• include in build process
  • before merge to develop
  • before merge to main and release cut

Benefits:

• Ensure quality written script files
• improve developer skill at writing better script files
• Provide example of

Drawbacks:

• Slows the build process
• May not be useful

How to Compare:

• Should write more consistent looking script files.
• Should find places to improve shell scripts

Describe the Improvement:
Add lines to run lint and test scripts before commits are allowed

Benefits:

• Runs linting and testing files before every commit

Drawbacks:

• slows the development process

How to Compare:

• is increase in development time worth running these all the time? I think so
• can we only run linting/tests related to changes in that commit?

Describe the change:
Found a couple things unclear when creating https://github.com/devlinjunker/dev.junk.cron

• Forgot to fetch submodules after using as template: git submodule update --init --recursive
• Not clear what linter is running on/if its successful
  • also linter only ran on scripts/ dir initially
• Not immediately clear which hooks/ scripts are hooks vs internal
  • maybe prefix internals with _ or put in internal/ subdir
• Unable to push wip commits that don't pass linting, should we ignore linting/testing these in pre-push.sh hook script?
• It would be nice to have example BATS file: https://gist.github.com/devlinjunker/c02db8e10c7017b493bb75b767739746

Additional context/Links:
N/A

Describe the Improvement:
Add unit tests to shell scripts

• https://opensource.com/article/19/2/testing-bash-bats
• https://www.client9.com/static-analysis-for-bash-and-shell-scripts/

Benefits:

• Run in merge-verify actions
• Help complete CII ranking for this project

Drawbacks:

• Have to write unit tests for shell scripts

How to Compare:
catch errors before we merge

Describe the change:

• Add FAQ wiki page that can be linked in README
• Update home wiki page to point at FAQ and Semver project Wiki
• Add link to Wiki/FAQ in README setup steps
• Add link to README Wiki in README setup steps: https://github.com/devlinjunker/example.cii/wiki/.README-(synced)
• Add link to GitHub Semver Project setup steps in README and FAQ
  • maybe edit to If forking to a new project, follow the New Project Setup Steps
• Clean up/update CONTRIBUTING file

Additional context/Links:
https://github.com/devlinjunker/template.github.semver/wiki/!%20FAQ