Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
J
Jupyter Docker Stacks
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
nanahira
Jupyter Docker Stacks
Commits
bf39616d
Commit
bf39616d
authored
Jul 24, 2020
by
Romain
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
documentation
parent
bbd4217a
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
43 additions
and
7 deletions
+43
-7
docs/contributing/lint.md
docs/contributing/lint.md
+43
-7
No files found.
docs/contributing/lint.md
View file @
bf39616d
# Image Lint
# Lint
In order to enforce some rules
**linters**
are used in this project.
Linters can be run either during the
**development phase**
(by the developer) and during
**integration phase**
(by Travis).
To integrate and enforce this process in the project lifecycle we are using
**git hooks**
through
[
pre-commit
][
pre-commit
]
.
## Pre-commit hook
### Installation
pre-commit is a Python package that needs to be installed.
This can be achieved by using the generic task used to install all Python development dependencies.
```
sh
# Install all development dependencies for the project
$
make dev-env
# It can also be installed directly
$
pip
install
pre-commit
```
Then the git hooks scripts configured for the project in
`.pre-commit-config.yaml`
need to be installed in the local git repository.
```
sh
$
make pre-commit-install
```
### Run
Now pre-commit (and so configured hooks) will run automatically on
`git commit`
on each changed file.
However it is also possible to trigger it against all files.
```
sh
$
make pre-commit-all
```
## Image Lint
To comply with
[
Docker best practices
][
dbp
]
, we are using the
[
Hadolint
][
hadolint
]
tool to analyse each
`Dockerfile`
.
To comply with
[
Docker best practices
][
dbp
]
, we are using the
[
Hadolint
][
hadolint
]
tool to analyse each
`Dockerfile`
.
## Installation
##
#
Installation
There is a specific
`make`
target to install the linter.
There is a specific
`make`
target to install the linter.
By default
`hadolint`
will be installed in
`${HOME}/hadolint`
.
By default
`hadolint`
will be installed in
`${HOME}/hadolint`
.
...
@@ -15,9 +50,9 @@ $ make lint-install
...
@@ -15,9 +50,9 @@ $ make lint-install
# Haskell Dockerfile Linter v1.17.6-0-gc918759
# Haskell Dockerfile Linter v1.17.6-0-gc918759
```
```
##
Lint
##
# Linting
### Per Stack
###
#
Per Stack
The linter can be run per stack.
The linter can be run per stack.
...
@@ -41,7 +76,7 @@ Optionally you can pass arguments to the linter.
...
@@ -41,7 +76,7 @@ Optionally you can pass arguments to the linter.
$
make lint/scipy-notebook
ARGS
=
"--format codeclimate"
$
make lint/scipy-notebook
ARGS
=
"--format codeclimate"
```
```
### All the Stacks
###
#
All the Stacks
The linter can be run against all the stacks.
The linter can be run against all the stacks.
...
@@ -49,7 +84,7 @@ The linter can be run against all the stacks.
...
@@ -49,7 +84,7 @@ The linter can be run against all the stacks.
$
make lint-all
$
make lint-all
```
```
## Ignoring Rules
##
#
Ignoring Rules
Sometimes it is necessary to ignore
[
some rules
][
rules
]
.
Sometimes it is necessary to ignore
[
some rules
][
rules
]
.
The following rules are ignored by default and sor for all images in the
`.hadolint.yaml`
file.
The following rules are ignored by default and sor for all images in the
`.hadolint.yaml`
file.
...
@@ -75,4 +110,5 @@ RUN cd /tmp && echo "hello!"
...
@@ -75,4 +110,5 @@ RUN cd /tmp && echo "hello!"
[
dbp
]:
https://docs.docker.com/develop/develop-images/dockerfile_best-practices
[
dbp
]:
https://docs.docker.com/develop/develop-images/dockerfile_best-practices
[
rules
]:
https://github.com/hadolint/hadolint#rules
[
rules
]:
https://github.com/hadolint/hadolint#rules
[
DL3006
]:
https://github.com/hadolint/hadolint/wiki/DL3006
[
DL3006
]:
https://github.com/hadolint/hadolint/wiki/DL3006
[
DL3008
]:
https://github.com/hadolint/hadolint/wiki/DL3008
[
DL3008
]:
https://github.com/hadolint/hadolint/wiki/DL3008
\ No newline at end of file
[
pre-commit
]:
https://pre-commit.com/
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment