github logo
GitHub v5.3.0, Jan 24 23

github.getActionsPublicKey

Use this data source to retrieve information about a GitHub Actions public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider token must have admin rights to a repository to retrieve it’s action public key.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Github = Pulumi.Github;

return await Deployment.RunAsync(() => 
{
    var example = Github.GetActionsPublicKey.Invoke(new()
    {
        Repository = "example_repo",
    });

});
package main

import (
	"github.com/pulumi/pulumi-github/sdk/v5/go/github"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := github.GetActionsPublicKey(ctx, &github.GetActionsPublicKeyArgs{
			Repository: "example_repo",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.GithubFunctions;
import com.pulumi.github.inputs.GetActionsPublicKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = GithubFunctions.getActionsPublicKey(GetActionsPublicKeyArgs.builder()
            .repository("example_repo")
            .build());

    }
}
import pulumi
import pulumi_github as github

example = github.get_actions_public_key(repository="example_repo")
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const example = github.getActionsPublicKey({
    repository: "example_repo",
});
variables:
  example:
    fn::invoke:
      Function: github:getActionsPublicKey
      Arguments:
        repository: example_repo

Using getActionsPublicKey

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getActionsPublicKey(args: GetActionsPublicKeyArgs, opts?: InvokeOptions): Promise<GetActionsPublicKeyResult>
function getActionsPublicKeyOutput(args: GetActionsPublicKeyOutputArgs, opts?: InvokeOptions): Output<GetActionsPublicKeyResult>
def get_actions_public_key(repository: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetActionsPublicKeyResult
def get_actions_public_key_output(repository: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetActionsPublicKeyResult]
func GetActionsPublicKey(ctx *Context, args *GetActionsPublicKeyArgs, opts ...InvokeOption) (*GetActionsPublicKeyResult, error)
func GetActionsPublicKeyOutput(ctx *Context, args *GetActionsPublicKeyOutputArgs, opts ...InvokeOption) GetActionsPublicKeyResultOutput

> Note: This function is named GetActionsPublicKey in the Go SDK.

public static class GetActionsPublicKey 
{
    public static Task<GetActionsPublicKeyResult> InvokeAsync(GetActionsPublicKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetActionsPublicKeyResult> Invoke(GetActionsPublicKeyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetActionsPublicKeyResult> getActionsPublicKey(GetActionsPublicKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: github:index/getActionsPublicKey:getActionsPublicKey
  arguments:
    # arguments dictionary

The following arguments are supported:

Repository string

Name of the repository to get public key from.

Repository string

Name of the repository to get public key from.

repository String

Name of the repository to get public key from.

repository string

Name of the repository to get public key from.

repository str

Name of the repository to get public key from.

repository String

Name of the repository to get public key from.

getActionsPublicKey Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Key string

Actual key retrieved.

KeyId string

ID of the key that has been retrieved.

Repository string
Id string

The provider-assigned unique ID for this managed resource.

Key string

Actual key retrieved.

KeyId string

ID of the key that has been retrieved.

Repository string
id String

The provider-assigned unique ID for this managed resource.

key String

Actual key retrieved.

keyId String

ID of the key that has been retrieved.

repository String
id string

The provider-assigned unique ID for this managed resource.

key string

Actual key retrieved.

keyId string

ID of the key that has been retrieved.

repository string
id str

The provider-assigned unique ID for this managed resource.

key str

Actual key retrieved.

key_id str

ID of the key that has been retrieved.

repository str
id String

The provider-assigned unique ID for this managed resource.

key String

Actual key retrieved.

keyId String

ID of the key that has been retrieved.

repository String

Package Details

Repository
GitHub pulumi/pulumi-github
License
Apache-2.0
Notes

This Pulumi package is based on the github Terraform Provider.