Skip to content

Commit 4bc482e

Browse files
committed
docs: improvement document format
1 parent 2e1eb34 commit 4bc482e

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ GitHub Action for seamless deployment to [EvenNode](https://www.evennode.com) pl
44

55
> [!NOTE]
66
> This action requires an `EvenNode repository URL` and `SSH key` authorization.
7-
>
7+
>
88
> If you're not familiar with these, please refer to the documentation about deploying an EvenNode application and generating an SSH key for upload:
99
> https://www.evennode.com/docs/git-deployment
1010
@@ -23,20 +23,19 @@ name: Deploy to EvenNode
2323

2424
on:
2525
push:
26-
branches: [ main ]
26+
branches: [main]
2727

2828
jobs:
2929
deploy:
3030
runs-on: ubuntu-latest
3131
steps:
3232
- uses: actions/checkout@v4
33-
33+
3434
- name: Deploy to EvenNode
3535
uses: rodnye/evennode-deploy-action@v1
3636
with:
3737
key: ${{ secrets.EVENNODE_SSH_KEY }}
38-
git_url: 'git@git.evennode.com:the-repo.git'
39-
dot_env: ${{ secrets.DOT_ENV }}
38+
git_url: ${{ secrets.EVENNODE_GIT_URL }}
4039
```
4140
4241
## Recommended Usage
@@ -46,14 +45,14 @@ name: Deploy to EvenNode
4645

4746
on:
4847
push:
49-
branches: [ main ]
48+
branches: [main]
5049

5150
jobs:
5251
deploy:
5352
runs-on: ubuntu-latest
5453
steps:
5554
- uses: actions/checkout@v4
56-
55+
5756
- name: Deploy to EvenNode
5857
uses: rodnye/evennode-deploy-action@v1
5958
with:
@@ -66,22 +65,23 @@ jobs:
6665
```
6766
6867
**Why use secrets for credentials?**
68+
6969
- Allows different team members to use their own credentials
7070
- Enables easy rotation of credentials without code changes
7171
7272
## Inputs
7373
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 |
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 |
8585

8686
## About pre_commit_command
8787

@@ -106,4 +106,4 @@ This approach significantly reduces deployment time as the host doesn't need to
106106

107107
---
108108

109-
🍊 Created by [Rodny Estrada](https://github.com/rodnye)
109+
🍊 Created by [Rodny Estrada](https://github.com/rodnye)

0 commit comments

Comments
 (0)