Skip to content

Commit cedcb29

Browse files
committed
docs: update readme (#5)
Signed-off-by: m-d-key <m-d-key@users.noreply.github.com> Co-authored-by: m-d-key <m-d-key@users.noreply.github.com>
1 parent 9a12526 commit cedcb29

3 files changed

Lines changed: 38 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -682,3 +682,15 @@ Pod sas-wbj-1nnlkcd6ioyamys10picgz3ok-wxfbg:
682682
> ./wbctl create volume --name restore --snapshot f7b75b0f-6bad-4f76-a142-1c6d2fcd5a38
683683
6a51cb99-5ed0-4e91-80f5-d981e11a3b59
684684
```
685+
686+
## Contributing
687+
688+
Maintainers are not currently accepting patches and contributions to this
689+
project.
690+
691+
## License
692+
693+
This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE).
694+
695+
The dependencies of this project include third-party software, each under their
696+
own license. They are listed in [licenses/licenses.md](./licenses/licenses.md).

‎licenses/licenses.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Third-party licenses for this project
2+
Name | Version | License
3+
--- | --- | ---
4+
[github.com/creack/pty](https://github.com/creack/pty) | v1.1.24 | [github.com_creack_pty-LICENSE](github.com_creack_pty-LICENSE)
5+
[github.com/go-openapi/spec](https://github.com/go-openapi/spec) | v1.0.1 | [github.com_go-openapi_spec-LICENSE](github.com_go-openapi_spec-LICENSE)
6+
[github.com/google/uuid](https://github.com/google/uuid) | v1.6.0 | [github.com_google_uuid-LICENSE](github.com_google_uuid-LICENSE)
7+
[github.com/gotnospirit/messageformat](https://github.com/gotnospirit/messageformat) | v0.0.0-20221001023931-dfe49f1eb092 | [github.com_gotnospirit_messageformat-LICENSE](github.com_gotnospirit_messageformat-LICENSE)
8+
[github.com/jedib0t/go-pretty/v6](https://github.com/jedib0t/go-pretty/v6) | v6.8.3 | [github.com_jedib0t_go-pretty_v6-LICENSE](github.com_jedib0t_go-pretty_v6-LICENSE)
9+
[github.com/kubernetes-csi/external-snapshotter/client/v8](https://github.com/kubernetes-csi/external-snapshotter/client/v8) | v8.6.0 | [github.com_kubernetes-csi_external-snapshotter_client_v8-LICENSE](github.com_kubernetes-csi_external-snapshotter_client_v8-LICENSE)
10+
[github.com/magiconair/properties](https://github.com/magiconair/properties) | v1.18.12 | [github.com_magiconair_properties-LICENSE](github.com_magiconair_properties-LICENSE)
11+
[github.com/sassoftware/sas-ggdk](https://github.com/sassoftware/sas-ggdk) | v0.5.0 | [github.com_sassoftware_sas-ggdk-LICENSE](github.com_sassoftware_sas-ggdk-LICENSE)
12+
[github.com/spf13/afero](https://github.com/spf13/afero) | v1.15.0 | [github.com_spf13_afero-LICENSE](github.com_spf13_afero-LICENSE)
13+
[github.com/spf13/cobra](https://github.com/spf13/cobra) | v1.10.2 | [github.com_spf13_cobra-LICENSE](github.com_spf13_cobra-LICENSE)
14+
[github.com/spf13/pflag](https://github.com/spf13/pflag) | v1.0.10 | [github.com_spf13_pflag-LICENSE](github.com_spf13_pflag-LICENSE)
15+
[github.com/spf13/viper](https://github.com/spf13/viper) | v1.21.0 | [github.com_spf13_viper-LICENSE](github.com_spf13_viper-LICENSE)
16+
[github.com/stretchr/testify](https://github.com/stretchr/testify) | v1.12.1 | [github.com_stretchr_testify-LICENSE](github.com_stretchr_testify-LICENSE)
17+
[golang.org/x/term](https://golang.org/x/term) | v0.43.0 | [golang.org_x_term-LICENSE](golang.org_x_term-LICENSE)
18+
[golang.org/x/text](https://golang.org/x/text) | v0.42.0 | [golang.org_x_text-LICENSE](golang.org_x_text-LICENSE)
19+
[k8s.io/api](https://k8s.io/api) | v0.36.1 | [k8s.io_api-LICENSE](k8s.io_api-LICENSE)
20+
[k8s.io/apimachinery](https://k8s.io/apimachinery) | v0.36.1 | [k8s.io_apimachinery-LICENSE](k8s.io_apimachinery-LICENSE)

‎scripts/update-licenses.sh‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ licenses() {
1515
workspace_root="$(git rev-parse --show-toplevel)"
1616
cd "${workspace_root}" || die "unable to cd to root: ${workspace_root}"
1717
mkdir -p "${workspace_root}/licenses" || die "unable to create ${workspace_root}/licenses"
18-
18+
index="${workspace_root}/licenses/licenses.md"
19+
echo "# Third-party licenses for this project" > "${index}"
20+
echo "Name | Version | License " >> "${index}"
21+
echo "--- | --- | --- " >> "${index}"
1922
modules="$(go list -m -f '{{if not (or .Indirect .Main)}}{{.Path}}@{{.Version}}{{end}}' all)"
2023

2124
echo "$modules" | while read -r module; do
@@ -38,6 +41,8 @@ licenses() {
3841
# Copy file content to the licenses folder
3942
echo " ...Copying licenses/${dst_name}"
4043
cp "${src_path}" "licenses/${dst_name}"
44+
# Append module information to the index file
45+
echo "[${module%@v*}](https://${module%@v*}) | ${module#*@} | [${dst_name}](${dst_name}) " >> "${index}"
4146
fi
4247
done
4348
done

0 commit comments

Comments
 (0)