Reading out enterprise and slug

Author: dkrizic

README.md

@@ -4,3 +4,66 @@ GitHub Action that can create various list of users from GitHub
 
 * All known GitHub users with their linked SSO accounts
 * List of all external collaborators and who invited them
+
+## User list
+
+Creates a markdown file with the list of all users of the enterprise.
+
+### Example
+
+> # GitHub Enterprise Users
+> | # | GitHub Login                                                     | E-Mail                  |
+> | --- |------------------------------------------------------------------|-------------------------|
+> | 1 | [foo](https://github.com/enterprises/prodyna/people/fassmus/sso) | [email protected]         |
+> | 2 | [bar](https://github.com/enterprises/prodyna/people/dkrizic/sso) | [email protected]         |
+
+### Using
+
+This action can be used in a workflow like this:
+
+```yaml
+ame: Create Overview
+
+on:
+  workflow_dispatch:
+  # Every day at 07:00
+  schedule:
+    - cron: '0 7 * * *'
+
+jobs:
+  create-overview:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the existing content of thre repository
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # Create directory profile if it does not exist
+      - name: Create profile directory
+        run: mkdir -p profile
+
+      # Run the deployment overview action
+      - name: Github users
+        uses: prodyna/[email protected]
+        with:
+          # The action to run
+          action: userlist
+          # The GitHub Enterprise to query for repositories
+          enterprise: octocat
+          # The GitHub Token to use for authentication
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          # The template file to use for rendering the result
+          template-file: template/userlist.tpl
+          # The markdown file to write the result to
+          markdown-file: USERS.md
+          # Verbosity level, 0=info, 1=debug
+          verbose: 1
+
+      # Push the generated files
+      - name: Commit changes
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "Deployment Overview"
+          git add profile
+          git commit -m "Add/update deployment overview"
+```

action.yaml

@@ -0,0 +1,35 @@
+name: 'GitHub Users'
+description: 'GitHub Action that creates list of enterprise users or allows automatic invitation of users'
+author: [email protected]
+inputs:
+  action:
+    description: 'The action to perform, currently supported: userlist'
+    required: true
+  enterprise:
+    description: 'The GitHub Enterprise to query for repositories'
+    required: true
+  github-token:
+    description: 'The GitHub Token to use for authentication'
+    required: true
+  template-file:
+    description: 'The template file to use for rendering the result'
+    required: false
+    default: '/template/userlist.tpl'
+  markdown-file:
+    description: 'The markdown file to write the result to'
+    required: false
+    default: 'USERS.md'
+  verbose:
+    description: 'The verbosity level'
+    required: false
+    default: 1
+runs:
+  using: 'docker'
+  image: 'docker://ghcr.io/prodyna/github-users:v0.1'
+  env:
+    ACTION: ${{ inputs.action }}
+    ENTERPRISE: ${{ inputs.enterprise }}
+    GITHUB_TOKEN: ${{ inputs.github-token }}
+    TEMPLATE_FILE: ${{ inputs.template-file }}
+    MARKDOWN_FILE: ${{ inputs.markdown-file }}
+    VERBOSE: ${{ inputs.verbose }}

template/userlist.tpl

@@ -1,6 +1,6 @@
-# GitHub Enterprise Users
+# GitHub Enterprise Users for {{ .Enterprise.Name }}
 
 | # | GitHub Login | E-Mail |
 | --- | --- | --- |
-{{ range .Users }} | {{ .Number }} | [{{ .Login }}](https://github.com/enterprises/prodyna/people/{{ .Login }}/sso) | {{ .Email }} |
+{{ range .Users }} | {{ .Number }} | [{{ .Login }}](https://github.com/enterprises/{{ $.Enterprise.Slug }}/people/{{ .Login }}/sso) | {{ .Email }} |
 {{end}}

userlist/userlist.go

@@ -24,7 +24,13 @@ type UserListConfig struct {
 }
 
 type UserList struct {
-	Users []User
+	Enterprise Enterprise
+	Users      []User
+}
+
+type Enterprise struct {
+	Slug string
+	Name string
 }
 
 type User struct {
@@ -157,6 +163,11 @@ func (c *UserListConfig) Load() error {
 		slog.ErrorContext(ctx, "Unable to query", "error", err)
 	}
 
+	c.userList.Enterprise = Enterprise{
+		Slug: query.Enterprise.Slug,
+		Name: query.Enterprise.Name,
+	}
+
 	for i, e := range query.Enterprise.OwnerInfo.SamlIdentityProvider.ExternalIdentities.Edges {
 		u := User{
 			Number: i + 1,