[
https://issues.apache.org/jira/browse/RAT-337?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17793359#comment-17793359
]
Bryan Ellis edited comment on RAT-337 at 12/5/23 5:01 PM:
----------------------------------------------------------
Should I begin transferring the repo?
I never transferred a repo into the Apache org before, and to a project I am
not a member of, so I would need to contact with Apache INFRA to find out the
procedures.
I will also rename it the repo before transferring so it fits your project
naming convention:
{code:java}
creadur-rat-action{code}
In terms of maintenance for this GitHub Action, whenever a new version of the
RAT tool is released, we just need to:
1. Update the default version in the *action.yml*
{code:java}
default: 0.15{code}
2. Create an appropriate *git tag*
E.g. If we already have version v1.0.0 released and the target is path or
minor...
{code:java}
git tag v1.0.1{code}
Since we expected that major version v1 is released, we need to also force
update the previous *v1* tag
{code:java}
git checkout v1.0.1
git tag v1 -f{code}
If we decide to create a new major *tag v2.0.0* then we will also need to
create *tag v2*
{code:java}
git checkout main
git tag v2.0.0
git tag v2{code}
*Additional Notes:*
This action pulls the rat binaries from Apache Archives.
If a new version of RAT is released and the Action was forgotten to be updated,
it will not cause failures for people's workflow that uses this Action.
Also, since the *rat-version* information is an {*}input{*}, users can also
pass whatever version they prefer to use. The version though must exist in the
archives. e.g. 0.15, 0.14...
was (Author: erisu):
Should I begin transferring the repo?
I never transferred a repo into the Apache org before, and to a project I am
not a member of, so I would need to contact with Apache INFRA to find out the
procedures.
I will also rename it the repo before transferring so it fits your project
naming convention:
{code:java}
creadur-rat-action{code}
In terms of maintenance for this GitHub Action, whenever a new version of the
RAT tool is released, we just need to:
1. Update the default version in the *action.yml*
{code:java}
default: 0.15{code}
2. Create an appropriate *git tag*
E.g. If we already have version v1.0.0 released and the target is path or
minor...
{code:java}
git tag v1.0.1{code}
Since we expected that major version v1 is released, we need to also force
update the previous *v1* tag
{code:java}
git checkout v1.0.1
git tag v1 -f{code}
If we decide to create a new major *tag v2.0.0* then we will also need to
create *tag v2*
**
{code:java}
git checkout main
git tag v2.0.0
git tag v2{code}
**
*Additional Notes:*
This action pulls the rat binaries from Apache Archives.
If a new version of RAT is released and the Action was forgotten to be updated,
it will not cause failures for people's workflow that uses this Action.
Also, since the *rat-version* information is an {*}input{*}, users can also
pass whatever version they prefer to use. The version though must exist in the
archives. e.g. 0.15, 0.14...
> 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@v1
> {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)
