Skip to content

Commit

Permalink
UPDATE README
Browse files Browse the repository at this point in the history
  • Loading branch information
John Ouellet committed Oct 14, 2021
1 parent 0d68625 commit 8ffc50b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
12 changes: 6 additions & 6 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ jobs:
- ubuntu-20.04
steps:
- uses: actions/checkout@v2
- name: run action
id: run_action
- name: Test Action
id: test_action
uses: ./
with:
github_token: ${{ secrets.TRANSFER_ISSUE_TOKEN }}
labels_file_path: '.github/transfer-issue-labels.yml'
map_repo_labels_file_path: '.github/transfer-issue-map-repo-labels.yml'
- name: Echo Output Data
if: steps.run_action.outputs.transferred_issue_number != ''
if: steps.test_action.outputs.transferred_issue_number != ''
run: |
echo ${{steps.run_action.outputs.transferred_issue_number}}
echo ${{steps.run_action.outputs.transferred_issue_url}}
echo ${{steps.run_action.outputs.transferred_repo}}
echo ${{steps.test_action.outputs.transferred_issue_number}}
echo ${{steps.test_action.outputs.transferred_issue_url}}
echo ${{steps.test_action.outputs.transferred_repo}}
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

A GitHub Action for transferring issues between github repos. It also has the ability to do the following:

* Optionally create a stub issue in the original issue that is closed and locked. This allows for a better user experience when search for issues in the old repo. The stub message will have the following message attached to it as well:
* Optionally create a stub issue in the original issue that is closed and locked. This allows for a better user experience when search for issues in the old repo. The stub issue will have the following comment attached to it as well:
```
@issue-author this is a stub issue that has been created as a placeholder in this repo.
Your original issue has been moved to link-to-transferred-repo-issue
```
* Optionally create labels from a file and add the labels the transferred issue.
* Optionally create labels from a file and add the labels to the transferred issue.
* Optionally map the triggered label to a file of keyed repos to send the issue to.

## Inputs
Expand Down Expand Up @@ -85,14 +85,15 @@ trill: tronic

## Advanced Example

In this example, we are not creating a stub and just updating the tranferred issue via [https://github.com/actions/github-script](https://github.com/actions/github-script).
In this example, we are using our own [PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) for authentication. We are also not creating a stub and just adding a comment to the tranferred issue via [https://github.com/actions/github-script](https://github.com/actions/github-script).

```
- name: Transfer Issue & Create Stub
uses: lando/[email protected]
id: transfer-issue
with:
create_stub: false
github_token: ${{ secrets.TRANSFER_ISSUE_TOKEN }}
labels_file_path: '.github/transfer-issue-labels.yml'
map_repo_labels_file_path: '.github/transfer-issue-map-repo-labels.yml'
- name: Update Transferred Issue
Expand All @@ -105,7 +106,6 @@ In this example, we are not creating a stub and just updating the tranferred iss
repo: `${{ steps.transfer-issue.outputs.transferred_repo }}`,
body: `@${ context.payload.issue.user.login } your issue is over here now!`
});
```

## Notes
Expand Down

0 comments on commit 8ffc50b

Please sign in to comment.