.github/actions/assign-triage-role/README.rst

..
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..
..     http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
..

******************
assign-triage-role
******************

Assigns the GitHub Triage role to non-committers who have fixed 2 Issues in the past month.

Environment Variables
=====================

+----------------------------+----------------------------------------------------------------------------------+
| Environment Variable Name  | Value                                                                            |
+============================+==================================================================================+
| ``GITHUB_TOKEN``           | Required. ``${{ github.token }}`` or ``${{ secrets.GITHUB_TOKEN }}``             |
+----------------------------+----------------------------------------------------------------------------------+
| ``PR_GITHUB_TOKEN``        | Required. ``${{ github.token }}`` or another token                               |
+----------------------------+----------------------------------------------------------------------------------+
| ``GIT_AUTHOR_NAME``        | Optional. The username to associate with the commit that updates the Go version. |
+----------------------------+----------------------------------------------------------------------------------+
| ``MINIMUM_COMMITS``        | Required. The lowest number of Issue-closing Pull Requests a Contributor can     |
|                            | have in order to be granted *Collaborator* status.                               |
+----------------------------+----------------------------------------------------------------------------------+
| ``SINCE_DAYS_AGO``         | The number of days ago to start counting Issue-closing Commits since             |
+----------------------------+----------------------------------------------------------------------------------+

Outputs
=======

``exit-code``
-------------

Exit code is 0 unless an error was encountered.

Example usage
=============

.. code-block:: yaml

	- name: Assign Triage Role
	  run: python3 -m assign_triage_role
	  env:
	    GIT_AUTHOR_NAME: asf-ci
	    GITHUB_TOKEN: ${{ github.token }}
	    MINIMUM_COMMITS: 5
	    SINCE_DAYS_AGO: 45

Tests
=====

To run the unit tests:

.. code-block:: shell

	python3 -m unittest discover ./tests