Skip to content
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Updating ReadMe for GitHub App Permissions
Signed-off-by: Elamaran Shanmugam <[email protected]>
  • Loading branch information
elamaran11 committed Apr 11, 2024
commit 29431a52fbecfb04da4619a5a2d7bbbcd7fe0c08
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,17 @@ GITHUB_APP_FILE=$(ls github-app-* | head -n1)
mv ${GITHUB_APP_FILE} private/github-integration.yaml
```

If you are using the above process to GitHub App, please make sure to select third option below, if your GitHub App access needs publishing access to create GitHub repositories for your backstage templates:

```bash
npx '@backstage/cli' create-github-app ${GITHUB_ORG_NAME}
? Select permissions [required] (these can be changed later but then require approvals in all installations) (Press <space> to select, <a> to toggle all, <i> to invert selection,
and <enter> to proceed)
◉ Read access to content (required by Software Catalog to ingest data from repositories)
◉ Read access to members (required by Software Catalog to ingest GitHub teams)
❯◯ Read and Write to content and actions (required by Software Templates to create new repositories)
Comment on lines +77 to +81
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like adding some more detail to line 70 and embedding this bit after line 75 would be better than duplicating the entire block here. can you combine the two pleaase?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nimakaviani Done pls check!

```

**The file created above contains credentials. Handle it with care.**

The rest of the installation process assumes the GitHub app credentials are available at `private/github-integration.yaml`
Expand Down