You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@creadur.apache.org by "Bryan Ellis (Jira)" <ji...@apache.org> on 2023/12/02 02:04:00 UTC

[jira] [Updated] (RAT-337) Apache RAT - GitHub Action

     [ https://issues.apache.org/jira/browse/RAT-337?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Ellis updated RAT-337:
----------------------------
    Description: 
The Release Audit Tool is great for detecting "Unknown Licenses" when missing or when the header license is not Apache.

In our Apache project, we are using this tool during our release process.

Many times new files are created without license headers and not noticed until the release phase.  

For projects that use GitHub and GitHub Action workflows, I believe providing an action that can test on PR submission and push would be beneficial.

Here is a GitHub Action composite workflow that was created to achieve this goal.

https://github.com/erisu/apache-rat-action

And here is the repo I used to test the above action.

https://github.com/erisu/apache-rat-action-test

This action only runs on Linux and could be updated to work on macOS. The way it is currently written will not work on Windows.

If you think this action is useful and would like to take ownership, I could transfer the repo.

In the above example the GitHub Action usage is:

{code:java}
- uses: erisu/apache-rat-action@bc7dcd0534e8681fe7530ad58170821dc6dd15f9
{code}

And if transfered and properly tagged, it could become:

{code:java}
- uses: apache/creadur-rat-action@v1
{code}

  was:
The Release Audit Tool is great for detecting "Unknown Licenses" when missing or when the header license is not Apache.

In our Apache project, we are using this tool during our release process.

Many times new files are created without license headers and not noticed until the release phase.  

For projects that use GitHub and GitHub Action workflows, I believe providing an action that can test on PR submission and push would be beneficial.

Here is a GitHub Action composite workflow that was created to achieve this goal.

https://github.com/erisu/apache-rat-action

And here is the repo I used to test the above action.

https://github.com/erisu/apache-rat-action-test

This action only runs on Linux and could be updated to work on macOS. The way it is currently written will not work on Windows.

If you think this action is useful and would like to take ownership, I could transfer the repo.

In the above example the GitHub Action usage is:

```
- uses: erisu/apache-rat-action@bc7dcd0534e8681fe7530ad58170821dc6dd15f9
```

And if transfered and properly tagged, it could become:

```
- uses: apache/creadur-rat-action@v1
```


> Apache RAT - GitHub Action
> --------------------------
>
>                 Key: RAT-337
>                 URL: https://issues.apache.org/jira/browse/RAT-337
>             Project: Apache Rat
>          Issue Type: Wish
>            Reporter: Bryan Ellis
>            Priority: Trivial
>
> The Release Audit Tool is great for detecting "Unknown Licenses" when missing or when the header license is not Apache.
> In our Apache project, we are using this tool during our release process.
> Many times new files are created without license headers and not noticed until the release phase.  
> For projects that use GitHub and GitHub Action workflows, I believe providing an action that can test on PR submission and push would be beneficial.
> Here is a GitHub Action composite workflow that was created to achieve this goal.
> https://github.com/erisu/apache-rat-action
> And here is the repo I used to test the above action.
> https://github.com/erisu/apache-rat-action-test
> This action only runs on Linux and could be updated to work on macOS. The way it is currently written will not work on Windows.
> If you think this action is useful and would like to take ownership, I could transfer the repo.
> In the above example the GitHub Action usage is:
> {code:java}
> - uses: erisu/apache-rat-action@bc7dcd0534e8681fe7530ad58170821dc6dd15f9
> {code}
> And if transfered and properly tagged, it could become:
> {code:java}
> - uses: apache/creadur-rat-action@v1
> {code}



--
This message was sent by Atlassian Jira
(v8.20.10#820010)