Skip to content

Commit

Permalink
Update CHANGELOG, add README blurb about Black format
Browse files Browse the repository at this point in the history
  • Loading branch information
CBonnell committed Oct 23, 2024
1 parent 278b212 commit d8962a9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

All notable changes to this project from version 0.9.3 onwards are documented in this file.

## 0.12.3 - 2024-10-23

### New features/enhancements

- Reformat codebase to use [Black](https://github.com/psf/black) (#125)

## 0.12.2 - 2024-10-14

### Fixes
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ This tool lints end-entity S/MIME certificates against the
The `lint` sub-command requires that the user provide the certificate type/profile of the certificate so that the appropriate
validations are performed. There are three options:
1. Explicitly specify the type of S/MIME certificate using the `-t`/`--type` option. This may be useful when linting S/MIME certificates where the policy OIDs in the certificate do not map to a S/MIME validation level and generation.
1. Explicitly specify the type of S/MIME certificate using the `-t`/`--type` option. This may be useful when linting S/MIME certificates where the policy OIDs in the certificate do not map to an S/MIME validation level and generation.
2. Have the linter detect the type of certificate using the `-d`/`--detect` option. In this case, the linter will determine the validation level and generation using the policy OIDs included in the certificate. If a reserved CA/Browser Forum policy OID is found, then the corresponding validation level and generation are used. If no such reserved OIDs are found, then the optional mapping file (see below) is used. If no OIDs in the mapping file are found, then the tool exits with an error.
3. Have the linter detect the type of certificate using the `-g`/`--guess` option. This option uses the same identification procedure as the `--detect` option, with one major difference. Instead of exiting with an error upon being unable to find an appropriate policy OID, this option instead directs the linter to use heuristics to determine the validation level and generation.
Expand Down Expand Up @@ -418,12 +418,15 @@ Once the REST API server has been started, documentation will be available on th
## Bugs?
If you find a bug or other issue with pkilint, please create a Github issue.
If you find a bug or other issue with pkilint, please create a GitHub issue.
## Contributing
As we intend for this project to be an ecosystem resource, we welcome contributions. It is preferred that proposals for new
features be filed as Github issues so that design decisions, etc. can be discussed prior to submitting a pull request.
features be filed as GitHub issues so that design decisions, etc. can be discussed prior to submitting a pull request.
This project uses [Black](https://github.com/psf/black) code formatter. The CI/CD pipeline checks for compliance with
this format, so please ensure that any code contributions follow this format.
## Acknowledgements
Expand Down

0 comments on commit d8962a9

Please sign in to comment.