diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5e56e04 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/bin diff --git a/Dockerfile b/Dockerfile index cddd48c..a9e1cb0 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,7 +1,7 @@ # Container image that runs your code FROM ubuntu:20.04 -ENV cli_version="v0.12.0" +ENV cli_version="v0.15.0" RUN set -eux; \ apt update; \ @@ -14,5 +14,7 @@ RUN chmod +x licensebat; \ # Copies your code file from your action repository to the filesystem path `/` of the container COPY entrypoint.sh /entrypoint.sh +RUN chmod +x /entrypoint.sh + # Code file to execute when the docker container starts up (`entrypoint.sh`) ENTRYPOINT ["/entrypoint.sh"] diff --git a/LICENSE b/LICENSE index 528c465..b08dde0 100644 --- a/LICENSE +++ b/LICENSE @@ -22,4 +22,4 @@ 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. \ No newline at end of file +DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index c8dfbbe..154975e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Licensebat GitHub Action -This GitHub action allows you to use Licensebat to check that the licenses of your project's dependencies are valid according to your licensing policy. +This GitHub action allows you to use [Licensebat](https://docs.rs/licensebat-cli) to check that the licenses of your project's dependencies are valid according to your licensing policy. The action will fail if it finds an invalid license. @@ -18,6 +18,8 @@ Note that this action uses [job summaries](https://github.blog/2022-05-09-superc **Optional** `.licrc` file path. Default `".licrc"`. +[Learn more about the .licrc file](https://docs.rs/licensebat-cli/latest/licensebat_cli/#the-licrc-file). + ## Example usage ```bash diff --git a/action.yaml b/action.yaml index c832843..f015414 100644 --- a/action.yaml +++ b/action.yaml @@ -24,4 +24,5 @@ runs: - ${{ inputs.dependency-file-path }} - -l - ${{ inputs.licrc-path }} - - -f md + - -f + - md diff --git a/entrypoint.sh b/entrypoint.sh index adef83d..ac2a43b 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -2,4 +2,4 @@ set -e licensebat $* >> $GITHUB_STEP_SUMMARY -exit $? \ No newline at end of file +exit $? diff --git a/test/.licrc b/test/.licrc index f43bee1..435d3f0 100644 --- a/test/.licrc +++ b/test/.licrc @@ -16,4 +16,4 @@ ignored=["ignored_dep1", "ignored_dep2"] # False by default, if true, it will only run the checks when one of the dependency files or the .licrc file has been modified. run_only_on_dependency_modification = true # False by default, if true, it will never block the build. -do_not_block_pr = false \ No newline at end of file +do_not_block_pr = false