initial version

Author: tspascoal

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Tiago Pascoal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 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.

README.md

@@ -0,0 +1,70 @@
+# get-user-teams-membership
+
+[GitHub Action](https://github.com/features/actions) to get the list of teams a user belongs in a given organization.
+It can also be optionally used to check if the user belongs to a given team
+
+It emits two outputs which are available via the `steps` [output context](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context)
+
+* Array with the least of teams the user belongs (since it's array you can check if a user belongs to a team using [contains](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#contains) function)
+* A boolean indicating if a user belongs to a given team (always false if `team` parameter is not used)
+
+# Usage
+
+See [action.yml](action.yml)
+
+```yaml
+- uses: tspascoal/get-user-teams-membership@v1
+  with:
+    username: # The github username for which we want to fetch teams membership in a given organization.
+    organization: # optional. Default value ${{ github.repository_owner }} 
+                  # Organization to get membership from.
+    team: # optional. Check if user belong to this team. 
+          # If you just want to check membership of a particular team. (only team name, don't include orgname)
+    GITHUB_TOKEN: # Personal access token used to query github (Requires scope: `read:org`)
+```
+
+## Requirements
+
+In order to use this action you need to use a [personal access token] 
+with `read:org` [scope](https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes) 
+(so the builtin in [GITHUB_TOKEN](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) is not enough)
+
+## Scenarios
+
+- [Checks if user belongs to one team or another](#Checks-if-user-belongs-to-one-of-two-teams)
+- [Checks if a user belongs to a given team](#Checks-if-user-belongs-to-a-given-team)
+
+### Checks if user belongs to one of two teams
+
+Checks if the user who triggered the worfklow (actor) belongs to one of two teams that define `A team` 
+and if not adds a label to the pull request to signal it's an external contribution.
+
+```yaml
+-  uses: tspascoal/get-user-teams-membership@v1
+   id: actorTeams
+   with:
+     username: ${{ github.actor }}
+     GITHUB_TOKEN: ${{ secrets.PAT }}
+- if: ${{ !(contains(steps.actorTeams.outputs.teams, 'A team members') || contains(steps.actorTeams.outputs.teams.teams, 'A team admins')) }}
+  name: Label PR as external contribution
+  ...  
+```
+
+### Checks if user belongs to a given team
+
+Checks if the user who triggered the worfklow (actor) doesn't belong to the `octocats` team
+
+```yaml
+-  uses: tspascoal/get-user-teams-membership@v1
+   id: checkUserMember
+   with:
+     username: ${{ github.actor }}
+     team: 'octocats'
+     GITHUB_TOKEN: ${{ secrets.PAT }}
+- if: ${{ !steps.checkUserMember.outputs.isTeamMember }}
+  ...  
+```
+
+## License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE)

action.yml

@@ -0,0 +1,26 @@
+name: 'login-teams-membership'
+description: 'Get a user teams membership in an organization'
+inputs:
+  organization: 
+    description: 'Organization name (default is repo owner)'
+    required: false
+    default:  ${{ github.repository_owner }}
+  username:
+    description: 'Username to get teams or check team membership'
+    required: true
+  team:
+    description: 'If you specify a team name it will output if the user is a member of that team (case insensitive)'
+    required: false
+    default: ''
+  GITHUB_TOKEN:
+    description: 'GITHUB_TOKEN'
+    required: true
+
+outputs:
+  teams: 
+    description: 'The list of teams the user belongs (array)'
+  isTeamMember:
+    description: 'Predicate to indicate if user belongs to team'
+runs:
+  using: 'node12'
+  main: 'index.js'

index.js

@@ -0,0 +1,62 @@
+const core = require('@actions/core')
+const github = require('@actions/github')
+
+run()
+
+async function run() {
+
+    try {
+
+        const api = github.getOctokit(core.getInput("GITHUB_TOKEN", { required: true }), {})
+
+        const organization = core.getInput("organization") || context.repo.owner
+        const username = core.getInput("username")
+        const team = core.getInput("team")
+
+        console.log(`Getting teams for ${username} in org ${organization}. Will check if belongs to ${team}`)
+
+        const query = `query($cursor: String, $org: String!, $userLogins: [String!])  {
+            organization(login: $org) {      
+              teams (first:1, userLogins: $userLogins, after: $cursor) { 
+                  nodes {
+                    name
+                }
+                pageInfo {
+                  hasNextPage
+                  endCursor
+                }        
+              }
+            }
+        }`
+
+        let org
+        let teams = []
+        let cursor = null
+        
+        // Paginate
+        do {
+            org = await api.graphql(query, {
+                "cursor": cursor,
+                "org": organization,
+                "userLogins": [username]
+            })
+
+            teams = teams.concat(org.organization.teams.nodes.map((val) => {
+                return val.name
+            }))
+            
+            cursor = org.organization.teams.pageInfo.endCursor   
+
+        } while (org.organization.teams.pageInfo.hasNextPage)
+
+        let isTeamMember = teams.some((teamName) => {
+            return team.toLowerCase() === teamName.toLowerCase()
+        })
+
+        core.setOutput("teams", teams)
+        core.setOutput("isTeamMember", isTeamMember)
+
+    } catch (error) {
+        core.setFailed(error.message)
+    }
+}