diff --git a/LICENSE b/LICENSE index 08356e9..f653410 100644 --- a/LICENSE +++ b/LICENSE @@ -1,19 +1,12 @@ Copyright (c) 2023 Aaron Bull Schaefer and contributors -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/README.md b/README.md index f8e7e6d..d16da1a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ # Reusable Workflows -This repository houses a collection of [reusable workflows][] for GitHub -Actions. Its primary goal is to centralize common workflows used across multiple -projects, streamlining the process of updating actions and sharing improvements -consistently. +This repository houses a collection of [reusable workflows][] for GitHub Actions. +Its primary goal is to centralize common workflows used across multiple projects, +streamlining the process of updating actions and sharing improvements consistently. ## Usage @@ -79,9 +78,9 @@ The `level` input specifies the [bump level][] of the release you're preparing. The `APP_ID` and `APP_PRIVATE_KEY` [encrypted secrets][secrets] must be available in the environment. They should correspond to a GitHub Apps application previously set up by your organization. The application is used to -generate an installation access token via the [github-app-token action][], and -is required in order for subsequent steps in the release process to be -automatically triggered. +generate an installation access token via the [github-app-token action][], and is +required in order for subsequent steps in the release process to be automatically +triggered. The permissions that the GitHub Apps application will need on the repository are: @@ -291,8 +290,8 @@ the [actionlint action][]. ### preload-caches-rust.yml Saves the repository's Rust project dependencies for both the _stable_ and -_MSRV_ (Minimum Supported Rust Version) toolchains into the [GitHub Actions -cache][], using [rust-cache][]. +_MSRV_ (Minimum Supported Rust Version) toolchains into the [GitHub +Actions cache][], using [rust-cache][]. --- @@ -337,11 +336,10 @@ rules. | :-------------- | :----- | :------- | | `needs_context` | string | true | -The [`needs` context][] contains outputs from all jobs that are defined as a -direct dependency of the current job, and is automatically populated by GitHub -Actions. Here, the `needs_context` input value should be the JSON representation -of that built-in context information, which you can set using the [expression][] -`${{ toJson(needs) }}`. +The [`needs` context][] contains outputs from all jobs that are defined as a direct +dependency of the current job, and is automatically populated by GitHub Actions. +Here, the `needs_context` input value should be the JSON representation of that built-in +context information, which you can set using the [expression][] `${{ toJson(needs) }}`. #### Example @@ -383,9 +381,9 @@ completes, it will display an annotation with any new tags. The `APP_ID` and `APP_PRIVATE_KEY` [encrypted secrets][secrets] must be available in the environment. They should correspond to a GitHub Apps application previously set up by your organization. The application is used to -generate an installation access token via the [github-app-token action][], and -is required in order for subsequent steps in the release process to be -automatically triggered. +generate an installation access token via the [github-app-token action][], and is +required in order for subsequent steps in the release process to be automatically +triggered. The permissions that the GitHub Apps application will need on the repository are: @@ -397,10 +395,13 @@ are: ## License -These reusable workflows are provided under the terms of the -[MIT License](LICENSE). +These reusable workflows are released under the [Zero Clause BSD +License][LICENSE] (SPDX: 0BSD). -Copyright © 2023 [Aaron Bull Schaefer](mailto:aaron@elasticdog.com) +Copyright © 2023 [Aaron Bull Schaefer][EMAIL] and contributors + +[LICENSE]: https://github.com/EarthmanMuons/spellout/blob/main/LICENSE +[EMAIL]: mailto:aaron@elasticdog.com