Skip to content

Commit 2e1eb34

Browse files
committed
docs: update inputs table in readme
1 parent 802d27a commit 2e1eb34

1 file changed

Lines changed: 15 additions & 17 deletions

File tree

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ GitHub Action for seamless deployment to [EvenNode](https://www.evennode.com) pl
1414
- Automatic .env file configuration
1515
- Custom pre-commit and pre-push commands
1616
- Flexible branch targeting
17-
- Force push control
17+
- Fresh git history initialization to prevent shadow push errors
1818

1919
## Basic Usage
2020

@@ -35,8 +35,6 @@ jobs:
3535
uses: rodnye/evennode-deploy-action@v1
3636
with:
3737
key: ${{ secrets.EVENNODE_SSH_KEY }}
38-
git_email: 'john@example.com'
39-
git_name: 'John Peterson'
4038
git_url: 'git@git.evennode.com:the-repo.git'
4139
dot_env: ${{ secrets.DOT_ENV }}
4240
```
@@ -60,10 +58,11 @@ jobs:
6058
uses: rodnye/evennode-deploy-action@v1
6159
with:
6260
key: ${{ secrets.EVENNODE_SSH_KEY }}
63-
git_email: ${{ secrets.GIT_EMAIL }}
64-
git_name: ${{ secrets.GIT_NAME }}
6561
git_url: ${{ secrets.EVENNODE_GIT_URL }}
6662
dot_env: ${{ secrets.DOT_ENV }}
63+
pre_commit_command: |
64+
npm run build
65+
git add ./dist -f
6766
```
6867
6968
**Why use secrets for credentials?**
@@ -72,18 +71,17 @@ jobs:
7271
7372
## Inputs
7473
75-
| Input | Required | Description |
76-
|-------|----------|-------------|
77-
| `key` | Yes | SSH private key for EvenNode |
78-
| `git_email` | Yes | Git email for commits |
79-
| `git_name` | Yes | Git username for commits |
80-
| `git_url` | Yes | EvenNode Git repository URL |
81-
| `dot_env` | No | Content for .env file |
82-
| `commit_message` | No | Custom commit message |
83-
| `branch` | No | Target branch (default: main) |
84-
| `pre_commit_command` | No | Command to run before commit (e.g. build commands or adding build artifacts) |
85-
| `pre_push_command` | No | Command to run before push |
86-
| `force_push` | No | Force push (default: true) |
74+
| Input | Required | Default | Description |
75+
|-------|----------|---------|-------------|
76+
| `key` | Yes | - | SSH private key for EvenNode |
77+
| `git_url` | Yes | - | EvenNode Git repository URL |
78+
| `dot_env` | No | - | Content for .env file |
79+
| `commit_message` | No | `[evennode production build]` | Custom commit message |
80+
| `git_email` | No | `41898282+github-actions[bot]@users.noreply.github.com` | Git email for push |
81+
| `git_name` | No | `github-actions[bot]` | Git name for push |
82+
| `branch` | No | `main` | Branch to push |
83+
| `pre_commit_command` | No | - | Command to run before committing changes (e.g. build commands or adding build artifacts) |
84+
| `pre_push_command` | No | - | Command to run before pushing to EvenNode |
8785

8886
## About pre_commit_command
8987

0 commit comments

Comments
 (0)