Skip to content

Commit

Permalink
Merge pull request #79 from ds-modules/cg_refactor
Browse files Browse the repository at this point in the history
More edits to gh-scoped-creds doc
  • Loading branch information
balajialg authored Aug 6, 2024
2 parents 8a5fea2 + 3390291 commit e44166b
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions workflow/securely-push-github.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,12 @@

### Requesting Access/Installation:

1. **Create a GitHub App**:
- Go to GitHub -> Settings -> Developer Settings -> GitHub Apps -> New GitHub App.
- Fill in the required details and enable Device Flow.
- Set repository permissions to "Read & Write".
- Allow installation on "Any account".
- Save the `Client ID` and `Public Link` as the admins require this information.

2. **Install the App**:
- Follow instructions to install the GitHub App on your account or organization.
- Select specific repositories to grant access.

3. **Contact Datahub Infra Admins**:
- Request admins to add `gh-scoped-creds` to the Datahub instance you are using by using this [template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=felder%2Cbalajialg%2Cshaneknapp&labels=package-request&projects=&template=package_request.yml&title=Request+python+package+X+for+class+Y). Here is a [sample request](https://github.com/berkeley-dsep-infra/datahub/issues/4879) for adding `gh-scoped-creds` in Data100 hub. Please don't forget to add `Client ID` and `Public Link`
1. **Install the GithHub App**:
- Reach out to infra admins inorder to get the URL for the GitHub app that you need to install. Click the green button "install" after navigating to the app URL to install the app. Eg: Here is the list of [GitHub apps](https://github.com/organizations/berkeley-dsep-infra/settings/apps/) created for varied hubs.
- Select specific repositories for which you want to grant read and write access.

2. **Add gh-scoped-creds Package to Hub Image**:
- Request admins to add `gh-scoped-creds` to the hub's image by specifying the hub you are using via this [template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=felder%2Cbalajialg%2Cshaneknapp&labels=package-request&projects=&template=package_request.yml&title=Request+python+package+X+for+class+Y). Here is a [sample request](https://github.com/berkeley-dsep-infra/datahub/issues/4879) for adding `gh-scoped-creds` in Data100 hub.

### Using the Tool:

Expand Down

0 comments on commit e44166b

Please sign in to comment.