Skip to content

Update readme #25

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

Merged
merged 2 commits into from
Jun 25, 2025
Merged

Update readme #25

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53fbe5f
prerequesites
Songmu Jun 25, 2025
76a9e04
update
Songmu Jun 25, 2025
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
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ Latest version: v2.0.3

## Usage

### Prerequisites

Before using this action, you must checkout the source repository to ensure the files you want to push are available in the workflow:

```yaml
- uses: actions/checkout@v4
```

### Basic Usage

```yaml
- name: Push to another repository
uses: Songmu/action-push-to-another-repository@v2
Expand Down Expand Up @@ -107,12 +117,6 @@ jobs:

### Permissions

This action requires the following permissions:

**Source Repository (where the workflow runs):**
- `contents: read` - Read files from the source repository

**Destination Repository (where files are pushed):**
- `contents: write` - Write files and create commits
- `workflows: write` - Only needed if updating `.github/workflows/` files

Expand Down