load-used-actions

Load used actions from an entire organization, by calling the REST API with a Personal Access Token and loop through all workflows in all repositories in the user account or organization.

The output is stored with the name actions, which can be retrieved in another action with ${{ steps.<step id>.outputs.actions }}.

Used for inserting data into the internal actions marketplace.

Example usage

Minimal uses expression to use this action:

uses: devops-actions/[email protected]
with: 
    PAT: ${{ secrets.GITHUB_TOKEN }} # use an Access Token with correct permissions to view private repos if you need to

Note: the default GITHUB_TOKEN might only have read access to the current repository but can read the public repositories for any organization, depending on the specific setup of the GITHUB_TOKEN. Create a new access token (PAT or use a GitHub App) with repo scope to have full read-only access to the organization and use that as a parameter. To learn more about these types of tokens, read this blogpost.

Full example

This example shows how to use the action to get a json file with all the used actions in an organization. The json file is uploaded as an artefact in the third step.

#	Name	Description
1	Load used actions	Run this action to load all actions used in an organization. Note the id of this step
2a	Store json file	Output the json value from the output of the action in step 1, by using the id of step 1 in ${{ steps.<step id>.outputs.actions }}. Do note that this can be a string that is to long to fit in the Actions runtime!
2b	Use json file	File that has the json value from the output of the action in step 1, by using the id of step 1 in ${{ steps.<step id>.outputs.actions-file }}.
3	Upload result file as artefact	Upload the json file as an artefact

jobs:
  load-all-used-actions:
    runs-on: ubuntu-latest
    steps: 
      - uses: devops-actions/[email protected]
        name: Load used actions        
        id: load-actions
        with: 
          PAT: ${{ secrets.GITHUB_TOKEN }} # use an Access Token with correct permissions to view private repos if you need to

      - shell: pwsh        
        name: Show json file
        run: cat ${{ steps.load-actions.outputs.actions-file }}
            
      - name: Upload result file as artefact
        uses: actions/upload-artifact@v4
        with: 
          name: actions-file
          path: ${{ steps.load-actions.outputs.actions-file }}

Inputs

Name	Description
organization	The name of the organization to run on.
PAT	The Personal Access Token to use for the API calls.

Outputs

actions-file: path to file containing compressed json string with all the actions used in the workflows in the organization. The json is in the format:

[
    "actionLink": "actions/checkout",
    "count": 50,
    "workflows": [
        {
            "repo": "rajbos/actions-marketplace",
            "workflowFileName": "build-image.yml",
            "actionRef": "v3" # the 'version' of the reference being used, if any
            "actionVersionComment": null # the comment after the version, if any
        },
        {
            "repo": "rajbos/actions-marketplace",
            "workflowFileName": "build-image.yml",
            "actionRef": "6167776d96bd5da05da534aa9cea6d7c786c1c5a", # the 'version' of the reference being used, if any
            "actionVersionComment": "v3" # the comment after the 'version', if any
        },
        { "etc" : "--" }
    ]
]

Properties:

Name	Description
actionLink	The link to the action used in the workflow
count	The number of times the action was used in the workflow
workflows	An array of workflows that used the action

The workflow object has the following properties:

Name	Description
repo	The name of the repository that uses the action
workflowFileName	The name of the workflow file that was found in the directory .github/workflows/
actionRef	The 'version' of the reference being used, if any
actionVersionComment	The comment after the version', if any

Testing / running the code locally

To run this code locally, execute the entrypoint.ps1 script in the Src/PowerShell folder, and sent in the PAT and organization you want to use.