Description for owner input is confusing

I'm looking to migrate to this action from peter-murray/workflow-application-token-action (currently waiting on #111 for feature parity) and I found the documentation for the owner input confusing:

create-github-app-token/action.yml

Lines 22 to 24 in f2acddf

    
           owner: 
        
             description: "GitHub App owner (defaults to current repository owner)" 
        
             required: false

To me, the documentation implies that this should be the owner of the GitHub app itself, whereas if you trace through the code it's actually the owner for which the GitHub app is installed (i.e. the place you want to give the app access to).

create-github-app-token/lib/main.js

Lines 112 to 129 in f2acddf

    
           // https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#get-an-organization-installation-for-the-authenticated-app 
        
           const response = await request("GET /orgs/{org}/installation", { 
        
             org: parsedOwner, 
        
             request: { 
        
               hook: auth.hook, 
        
             }, 
        
           }).catch((error) => { 
        
             /* c8 ignore next */ 
        
             if (error.status !== 404) throw error; 
        
             // https://docs.github.com/rest/apps/apps?apiVersion=2022-11-28#get-a-user-installation-for-the-authenticated-app 
        
             return request("GET /users/{username}/installation", { 
        
               username: parsedOwner, 
        
               request: { 
        
                 hook: auth.hook, 
        
               }, 
        
             }); 
        
           });

the owner for which the GitHub app is installed

that is correct. Sorry for the confusion. We should definitely update the input description. Pull request welcome!

Update owner input description

🎉 This issue has been resolved in version 1.9.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Navigation Menu

Repository navigation

Description for owner input is confusing #116

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	owner:
	description: "GitHub App owner (defaults to current repository owner)"
	required: false

	// https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#get-an-organization-installation-for-the-authenticated-app
	const response = await request("GET /orgs/{org}/installation", {
	org: parsedOwner,
	request: {
	hook: auth.hook,
	},
	}).catch((error) => {
	/* c8 ignore next */
	if (error.status !== 404) throw error;

	// https://docs.github.com/rest/apps/apps?apiVersion=2022-11-28#get-a-user-installation-for-the-authenticated-app
	return request("GET /users/{username}/installation", {
	username: parsedOwner,
	request: {
	hook: auth.hook,
	},
	});
	});

Description for owner input is confusing #116

Description

Activity

gr2m commented on Mar 25, 2024

create-app-token-action-releaser commented on Mar 25, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions