Skip to content
Snippets Groups Projects
Commit eada4675 authored by Gauthier HEISS's avatar Gauthier HEISS
Browse files

Adding more instructions in the README file

parent d6153855
No related branches found
No related tags found
No related merge requests found
# Bash file scorer
Give a score out of 10 to (BA)SH scripts like other linter, using [Spellcheck](https://www.shellcheck.net)
Give a score out of 10 to (BA)SH scripts like other linter, using [Spellcheck](https://www.shellcheck.net).
## Use the scorer in standalone mode
......@@ -8,10 +8,14 @@ Download and run `score.sh` into your project directory. All `*.sh` and `*.bash`
## Use the scorer as a GitLab job and get a badge
Open your GitLab project's settings and create a new badge. Fill the form as bellow:
1. Open your GitLab project's general settings and create a new badge. Fill the form as bellow:
- Name: Bashlint
- Link: `https://gitlab.esiea.fr/%{project_path}/-/jobs/artifacts/%{default_branch}/browse/public/lint?job=bashlint`
- Badge image URL: `https://gitlab.esiea.fr/%{project_path}/-/jobs/artifacts/%{default_branch}/raw/public/badges/bashlint.svg?job=bashlint`
Save the newly created badge. It will be blank by default.
Then, copy the `.gitlab-ci.yml` of this repository into yours.
2. Check if CI/CD feature is enabled in general settings (it is by default).
The bash file scorer will run everytime you push something to your repository.
\ No newline at end of file
3. Then, copy the `.gitlab-ci.yml` file of this repository into yours. Be careful, the filename has to be identical, including the starting `.`.
4. The bash file scorer will run everytime you push something to your repository. You can run it manually by going to CI/CD > Pipelines and click on "Run pipeline".
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment