Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
hboutemy authored and slawekjaranowski committed Mar 21, 2021
1 parent 81be955 commit 800e163
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 20 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ target/
*.iml
*~
.DS_STORE
.project
.classpath
.settings/
8 changes: 4 additions & 4 deletions src/site/markdown/examples.md.vm
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ If you want check your dependency on each build, please add to your project:
keysMap usage
-------------

keysMap with pgp fingerprint from project
keysMap with PGP fingerprint from project

<pluginManagement>
<plugins>
Expand All @@ -64,7 +64,7 @@ keysMap with pgp fingerprint from project
</pluginManagement>


keysMap with pgp fingerprint from external artifact
keysMap with PGP fingerprint from external artifact

<pluginManagement>
<plugins>
Expand All @@ -90,7 +90,7 @@ keysMap with pgp fingerprint from external artifact
</pluginManagement>


keysMap with pgp fingerprint from external resource
keysMap with PGP fingerprint from external resource

<pluginManagement>
<plugins>
Expand Down Expand Up @@ -137,7 +137,7 @@ as a result we get
create date: Sun Jul 27 14:31:46 CEST 2014
uids: [.... (JUnit Development, 2014) <mail@....>]

By default, information about `jar` artifact is displayed, you can specify packaging, classifier,
By default, information about `jar` artifact is displayed. You can specify packaging, classifier,
artifact property format is:

groupId:artifactId:version[:packaging[:classifier]]
Expand Down
10 changes: 5 additions & 5 deletions src/site/markdown/index.md.vm
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
Introduction
============

This plugin allow you to automatically verify PGP signature of all project dependency.
This plugin allows you to automatically verify PGP signature of all project dependencies.

Features
--------

- check signature of artifacts during each build,
not only during artifact download from the remote repository to local
- possibility to map pgp key fingerprint to artifacts, so we can detect if correct key is used for making signature
- possibility to map PGP key fingerprint to artifacts, so we can detect if correct key was used for making signature
- possibility to check signature of maven plugins used during build
- there is no external software need to install - plugin use Bouncy Castle library to manage pgp operations
- works on many operating system and jdk versions - confirmed by CI builds - Linux, Windows, Mac OS, JDK 8, 11, 14
- there is no external software need to install - plugin uses Bouncy Castle library to manage PGP operations
- works on many operating system and JDK versions - confirmed by CI builds - Linux, Windows, Mac OS, JDK 8, 11, 14

Usage
-----
Expand All @@ -31,4 +31,4 @@ Support

Issues, bugs, new feature requests, questions can be submitted to [issue management system](issue-management.html).

If you need help don't hesitate to create new issue.
If you need help, don't hesitate to create new issue.
22 changes: 11 additions & 11 deletions src/site/markdown/keysmap-format.md.vm
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ The syntax of each line of properties file is:

Where

- `groupId` - groupId of maven artifact, this filed is required, but can be `*` for mach any
- `artifactId` - artifactId of maven artifact
- `packaging` - packaging of maven artifact, eg. `pom`, `jar`
- `version` - version of maven artifact, this filed support maven version range syntax
- `pgpKeyFingerprint` - pgp key fingerprints in hex format which are allowed to sign artifact,
can be supplied many keys separated by comma
- `groupId` - groupId of Maven artifact, this field is required, but can be `*` for match any
- `artifactId` - artifactId of Maven artifact
- `packaging` - packaging of Maven artifact, eg. `pom`, `jar`
- `version` - version of Maven artifact, this filed support Maven version range syntax
- `pgpKeyFingerprint` - PGP key fingerprints in hex format which are allowed to sign artifact,
multiple keys can be supplied separated by comma

PGP keys special values
----------------------

`pgpKey` field can contains many pgp fingerprints, separated by comma,
each fingerprint must start with `0x`. There are allowed whitespace in hex fingerprint.
`pgpKey` field can contains multiple PGP fingerprints, separated by comma,
each fingerprint must start with `0x`. Whitespace is allowed in hex fingerprint.

`pgpKey` can also contains special values:
`pgpKey` can also contain special values:

- `*`, `any` - match any key for artifact
- `noSig` - allow artifact without signature
Expand All @@ -42,9 +42,9 @@ Everything from `#` (hash sign) and continue to the end of the line are comment
Multiline
---------

If line is ending with ` \ ` (backslash) break of line will be removed and next line will be joined.
If line is ending with ` \ ` (backslash), break of line will be removed and next line will be joined.

There are allowed whitespace and comments after ` \ `.
Whitespace and comments are allowed after ` \ `.

Examples
--------
Expand Down

0 comments on commit 800e163

Please sign in to comment.