Skip to content

Commit

Permalink
docs: change release reference in rules documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
zavoloklom committed Dec 15, 2024
1 parent fe4f67f commit 39f6745
Show file tree
Hide file tree
Showing 18 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/errors/invalid-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To keep the schema current, you can manually update it and contribute to the pro

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/errors/invalid-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ the YAML structure, those issues will not be flagged by this rule either.

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/__TEMPLATE__.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Long rule description, why you should use it

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-build-and-image-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ process. Therefore, this rule enforces that each service should only use one of

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-duplicate-container-names-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ which can disrupt the container management process and network connections.

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-duplicate-exported-ports-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ ensure that environment variables used for ports are unique or manually check fo

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-quotes-in-volumes-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ enforcing this rule, we ensure a more reliable and consistent configuration.

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
12 changes: 6 additions & 6 deletions docs/rules/no-unbound-port-interfaces-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
When specifying ports for services in Docker Compose, it is recommended to explicitly set the host interface or IP
address to prevent accidental exposure to the network.

- **Rule Name**: no-unbound-port-interfaces
- **Type**: error
- **Category**: security
- **Severity**: major
- **Fixable**: no
- **Rule Name:** no-unbound-port-interfaces
- **Type:** error
- **Category:** security
- **Severity:** major
- **Fixable:** false

## Problematic Code Example

Expand Down Expand Up @@ -85,7 +85,7 @@ skip IP interface checks in such cases.

## Version

This rule was introduced in Docker-Compose-Linter [2.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v2.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-version-field-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ longer requires the "version" field. If you are working with older versions of D
## Version
This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
## References
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-project-name-field-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ accidental conflicts and improve the organization of your Docker environment.
## Version
This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
## References
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-quotes-in-ports-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ If you want to enforce the use of double quotes around port mappings you can do

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

Handling `expose` section is added in [2.0.0](https://github.com/zavoloklom/docker-compose-linter/releases)

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/service-container-name-regex-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ names are properly formatted according to Docker's naming conventions.

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/service-dependencies-alphabetical-order-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ large configurations.

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/service-image-require-explicit-tag-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ If you provide a `prohibitedTags` option, only the tags listed in the `prohibite

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/service-keys-order-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ If certain groups are not specified in the `groups` option, the default key orde

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/service-ports-alphabetical-order-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ configurations.
## Version
This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
## References
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/services-alphabetical-order-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ locate and manage services within the configuration file.
## Version
This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
## References
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/top-level-properties-order-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ grouped together and sorted alphabetically.

## Version

This rule was introduced in Docker-Compose-Linter [1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).
This rule was introduced in [v1.0.0](https://github.com/zavoloklom/docker-compose-linter/releases).

## References

Expand Down

0 comments on commit 39f6745

Please sign in to comment.