Skip to content

Commit

Permalink
feat: add documented local test flow
Browse files Browse the repository at this point in the history
  • Loading branch information
themightychris committed Nov 22, 2023
1 parent 600851b commit 50f8498
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
4 changes: 4 additions & 0 deletions github-actions/release-prepare/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
GITHUB_TOKEN=PASTE_YOUR_TOKEN
GITHUB_REPOSITORY=exampleorg/exampleproject
RELEASE_BRANCH=main
GITHUB_REF_NAME=develop
1 change: 1 addition & 0 deletions github-actions/release-prepare/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.env
19 changes: 19 additions & 0 deletions github-actions/release-prepare/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# GitHub Action: release-prepare

## Development

This action encapsulates most of its complexity in a standalone Bash script that accepts environment variables, making it easy to test locally with the help of a `.env` file you can point at a test repository.

1. Create `.env` from the template:

```bash
cp .env.example .env
```

2. Paste a GitHub token and tailor repository/branches to your test target.

3. Run bash script with `.env` applied to emulate GitHub Actions context:

```bash
eval $(< .env) ./pull-request.sh
```

0 comments on commit 50f8498

Please sign in to comment.