From be72b4d49ecf2fbcf27d8c2b4265b9b974f728d5 Mon Sep 17 00:00:00 2001 From: Jeffrey Paul Date: Wed, 31 May 2023 10:13:54 -0500 Subject: [PATCH 1/2] add license dependency details to README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7138b17..7d42fdf 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,10 @@ This action automates some common PR operations like validating PR description, If you follow the [JSDoc](https://jsdoc.app/) standard for your custom WordPress actions and filters, you can use this workflow to generate documentation for your theme/plugin and publish them to GitHub Pages. For an example of the output, see the [Distributor hook docs](https://10up.github.io/distributor/). The [linting workflow](https://github.com/10up/maps-block-apple/blob/develop/.github/workflows/linting.yml) of Block for Apple Maps is a good example how to use this action in practice. +### [Validating project dependency licensing]() + +If you publish projects that adhere to a certain license (e.g. GPLv2), then you will want to ensure any dependencies within your project adhere to a compatible license. We've crafted a [GitHub Action workflow](https://github.com/10up/insert-special-characters/blob/develop/.github/workflows/dependency-review.yml) and [GPL-Compatible License Policy file](https://github.com/10up/.github/blob/trunk/.github/dependency-review-config.yml) that can be leveraged to ensure your projects are GPL-compatible. Additional license policy files could be developed to ensure other licensing are valid (e.g. a MIT-Compatible License Policy file). + ### [Using markdown content in GitHub Actions summary](using-markdown-in-action-summary.md) In May 2022, GitHub introduced the [markdown support](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/) for the GitHub Actions summaries. This feature can help improve the developer experience by generating more useful reports to action summaries. From babec2d746357de5e80ce16c8774f0ee7fe06ac6 Mon Sep 17 00:00:00 2001 From: Jeffrey Paul Date: Wed, 31 May 2023 22:50:09 -0500 Subject: [PATCH 2/2] Update README.md Co-authored-by: Peter Wilson <519727+peterwilsoncc@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d42fdf..bfd610b 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ This action automates some common PR operations like validating PR description, If you follow the [JSDoc](https://jsdoc.app/) standard for your custom WordPress actions and filters, you can use this workflow to generate documentation for your theme/plugin and publish them to GitHub Pages. For an example of the output, see the [Distributor hook docs](https://10up.github.io/distributor/). The [linting workflow](https://github.com/10up/maps-block-apple/blob/develop/.github/workflows/linting.yml) of Block for Apple Maps is a good example how to use this action in practice. -### [Validating project dependency licensing]() +### Validating project dependency licensing If you publish projects that adhere to a certain license (e.g. GPLv2), then you will want to ensure any dependencies within your project adhere to a compatible license. We've crafted a [GitHub Action workflow](https://github.com/10up/insert-special-characters/blob/develop/.github/workflows/dependency-review.yml) and [GPL-Compatible License Policy file](https://github.com/10up/.github/blob/trunk/.github/dependency-review-config.yml) that can be leveraged to ensure your projects are GPL-compatible. Additional license policy files could be developed to ensure other licensing are valid (e.g. a MIT-Compatible License Policy file).