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.

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

docs(sync-files): add installation instructions #287

Merged
merged 4 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ This workflow checks if a certain secret is set.
#### Usage

```yaml
jobs:
jobs:
check-secret:
uses: autowarefoundation/autoware-github-actions/.github/workflows/check-secret.yaml@v1
Expand Down
29 changes: 29 additions & 0 deletions sync-files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,35 @@ It uses [peter-evans/create-pull-request](https://github.com/peter-evans/create-

Note that you need `workflow` permission for the token if you copy workflow files of GitHub Actions.

## Initial setup (within `autowarefoundation` org)

This action uses the <https://github.com/apps/awf-autoware-bot> app to create pull requests.

### Secrets

For this action to use this bot, it requires the following secrets:

- `APP_ID`: The app ID of the bot.
- Can be found in [awf-autoware-bot App Settings](https://github.com/organizations/autowarefoundation/settings/apps/awf-autoware-bot) General, About section.
- `PRIVATE_KEY`: The private key of the bot.
- Can be found/generated in [awf-autoware-bot App Settings](https://github.com/organizations/autowarefoundation/settings/apps/awf-autoware-bot) General, Private keys section.

Then these secrets need to be set in the repository settings.

- Target Repository GitHub Page, Settings, Secrets and variables, Actions, New repository secret, `APP_ID` and `PRIVATE_KEY`

### App settings

Also, you need to install the app to the target repository.

- [awf-autoware-bot App Settings](https://github.com/organizations/autowarefoundation/settings/apps/awf-autoware-bot) Install App section, Repository access, Only select repositories, add the target repository.

### Additional repository settings

For this action to work properly, the following settings are required in the target repository.

- Target Repository GitHub Page, Settings, General, Pull Requests, Allow auto-merge # Enable

## Usage

```yaml
Expand Down
Loading