Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Readme descriptions that say undefined because they're empty #153

Merged
merged 2 commits into from
Dec 13, 2024
Merged

fix: Readme descriptions that say undefined because they're empty #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9db690f
Fix up empty readmes to not say undefined
nalanj Dec 13, 2024
9f5aa6f
Print warning for missing descriptions
nalanj Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion integrations/asana/actions/delete-task.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## General Information

- **Description:** undefined
- **Description:**
- **Version:** 0.0.1
- **Group:** Others
- **Scopes:** _None_
Expand Down
2 changes: 1 addition & 1 deletion integrations/checkr-partner/actions/create-candidate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## General Information

- **Description:** undefined
- **Description:**
- **Version:** 0.0.1
- **Group:** Others
- **Scopes:** _None_
Expand Down
4 changes: 2 additions & 2 deletions integrations/google-drive/syncs/documents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
- **Description:** Sync the metadata of a specified file or folders from Google Drive,
handling both individual files and nested folders.
Metadata required to filter on a particular folder, or file(s). Metadata
fields should be {"files": ["<some-id>"]} OR
{"folders": ["<some-id>"]}. The ID should be able to be provided
fields should be `{"files": ["<some-id>"]}` OR
`{"folders": ["<some-id>"]}`. The ID should be able to be provided
by using the Google Picker API
(https://developers.google.com/drive/picker/guides/overview)
and using the ID field provided by the response
Expand Down
2 changes: 1 addition & 1 deletion integrations/google/syncs/workspace-org-units.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## General Information

- **Description:** undefined
- **Description:**
- **Version:** 0.0.1
- **Group:** Others
- **Scopes:** `https://www.googleapis.com/auth/admin.directory.orgunit.readonly, https://www.googleapis.com/auth/admin.directory.user.readonly`
Expand Down
2 changes: 1 addition & 1 deletion integrations/google/syncs/workspace-user-access-tokens.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## General Information

- **Description:** undefined
- **Description:**
- **Version:** 0.0.1
- **Group:** Others
- **Scopes:** `https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.user.security`
Expand Down
2 changes: 1 addition & 1 deletion integrations/google/syncs/workspace-users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## General Information

- **Description:** undefined
- **Description:**
- **Version:** 0.0.1
- **Group:** Others
- **Scopes:** _None_
Expand Down
6 changes: 5 additions & 1 deletion scripts/generate-readmes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,14 @@ function updateReadme(markdown: string, scriptName: string, scriptPath: string,
function generalInfo(scriptPath: string, endpointType: string, scriptConfig: any) {
const scopes = Array.isArray(scriptConfig.scopes) ? scriptConfig.scopes.join(', ') : scriptConfig.scopes;

if (!scriptConfig.description) {
console.warn(`Warning: no description for ${scriptPath}`);
}

return [
`## General Information`,
``,
`- **Description:** ${scriptConfig.description}`,
`- **Description:** ${scriptConfig.description ?? ''}`,
`- **Version:** ${scriptConfig.version ? scriptConfig.version : '0.0.1'}`,
`- **Group:** ${scriptConfig.group || 'Others'}`,
`- **Scopes:** ${scopes ? `\`${scopes}\`` : '_None_'}`,
Expand Down
Loading