chore: fix docs and e2e (#17)

- Add entry points for examples in `README.md` - Fix E2E test arguments - Add `.gitignore` - Replace `go.work` with `go.mod` --------- Signed-off-by: Shiwei Zhang <[email protected]>
notaryproject · Jan 31, 2024 · a1ec01f · a1ec01f
1 parent 29add9b
commit a1ec01f
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 34 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,20 @@
+# Copyright The Notary Project Authors.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# VS Code
+.vscode
+
+# Custom
+bin/
+vendor/
+test/e2e/bin/
diff --git a/Makefile b/Makefile
@@ -33,7 +33,6 @@ clean:
 .PHONY: check-line-endings
 check-line-endings: ## check line endings
 	! find . -name "*.go" -type f -exec file "{}" ";" | grep CRLF
-	! find scripts -name "*.sh" -type f -exec file "{}" ";" | grep CRLF
 
 .PHONY: fix-line-endings
 fix-line-endings: ## fix line endings

diff --git a/README.md b/README.md
@@ -14,13 +14,19 @@ Please visit [README](https://github.com/notaryproject/.github/blob/main/README.
 ## Table of Contents
 
 - [Documentation](#documentation)
+- [Example Plugins](#example-plugins)
 - [Code of Conduct](#code-of-conduct)
 - [License](#license)
 
 ## Documentation
 
 Library documentation is available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-plugin-framework-go).
 
+## Example Plugins
+
+- [Signature generator](example/signaturegenerator/)
+- [Envelope generator](example/envelopegenerator/)
+
 ## Code of Conduct
 
 This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for further details.

diff --git a/example/envelopegenerator/go.work b/example/envelopegenerator/go.work
diff --git a/example/go.mod b/example/go.mod
@@ -0,0 +1,7 @@
+module github.com/notaryproject/notation-plugin-framework-go/example
+
+go 1.20
+
+require github.com/notaryproject/notation-plugin-framework-go v0.0.0-00010101000000-000000000000
+
+replace github.com/notaryproject/notation-plugin-framework-go => ../
diff --git a/example/signaturegenerator/go.work b/example/signaturegenerator/go.work
diff --git a/test/e2e/run.sh b/test/e2e/run.sh
@@ -27,4 +27,4 @@ done
 # run e2e tests
 echo "running e2e tests..."
 echo "=============================="
-go test -race -v ./... -args -env_gen_plugin="./bin/${plugin_directories[0]}/$PLUGIN_NAME" - sig_gen_plugin="./bin/${plugin_directories[1]}/$PLUGIN_NAME"
+go test -race -v ./... -args -env_gen_plugin="./bin/${plugin_directories[0]}/$PLUGIN_NAME" -sig_gen_plugin="./bin/${plugin_directories[1]}/$PLUGIN_NAME"