Skip to content

Commit ad8225d

Browse files
SamKirklandSamKirkland
committed
readme, logs, action unique name
1 parent 6abcfae commit ad8225d

File tree

6 files changed

+74
-16
lines changed

6 files changed

+74
-16
lines changed

‎.github/workflows/dryrun-deploy.yml‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1-
on: push
21
name: Publish Website
2+
on:
3+
push:
34
jobs:
45
web-deploy:
56
name: 🚀 Deploy Website Every Commit
67
runs-on: ubuntu-latest
78
steps:
8-
- name: 🚚 Get Latest Code
9-
uses: actions/checkout@v3
10-
11-
- name: 📂 Sync Files
12-
uses: SamKirkland/web-deploy@v1
13-
with:
14-
target-server: mi3-sr24.supercp.com
15-
remote-user: samkirkland
16-
remote-key: ${{ secrets.SSH_KEY }}
17-
ssh-port: 7822
18-
destination-path: ~/
19-
rsync-options: --dry-run --archive --verbose --compress --delete-after --human-readable --exclude=.git* --exclude=.git/ --exclude=README.md --exclude=readme.md --exclude=.gitignore
9+
- name: 🚚 Get Latest Code
10+
uses: actions/checkout@v3
11+
12+
- name: 📂 Sync Files
13+
uses: SamKirkland/web-deploy@v1
14+
with:
15+
target-server: mi3-sr24.supercp.com
16+
remote-user: samkirkland
17+
remote-key: ${{ secrets.SSH_KEY }}
18+
ssh-port: 7822
19+
destination-path: ~/
20+
rsync-options: --dry-run --archive --verbose --compress --delete-after --human-readable --exclude=.git* --exclude=.git/ --exclude=README.md --exclude=readme.md --exclude=.gitignore

‎.github/workflows/test-report.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "tests"
1+
name: Tests
22
on:
33
pull_request:
44
push:

‎README.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,48 @@ _Want another example? Let me know by creating a [github issue](https://github.c
151151

152152
---
153153

154+
## Badge
155+
156+
If you appreciate this github action give it a :star: or show off with one of the badges below. Feel free to edit the text or color.
157+
158+
[<img alt="Deployed with web deploy" src="https://img.shields.io/badge/Deployed With-web deploy-%3CCOLOR%3E?style=for-the-badge&color=0077b6">](https://github.com/SamKirkland/web-deploy)
159+
160+
```md
161+
[<img alt="Deployed with web deploy" src="https://img.shields.io/badge/Deployed With-web deploy-%3CCOLOR%3E?style=for-the-badge&color=0077b6">](https://github.com/SamKirkland/web-deploy)
162+
```
163+
164+
[<img alt="Deployed with web deploy" src="https://img.shields.io/badge/Deployed With-web deploy-%3CCOLOR%3E?style=for-the-badge&color=2b9348">](https://github.com/SamKirkland/web-deploy)
165+
166+
```md
167+
[<img alt="Deployed with web deploy" src="https://img.shields.io/badge/Deployed With-web deploy-%3CCOLOR%3E?style=for-the-badge&color=2b9348">](https://github.com/SamKirkland/web-deploy)
168+
```
169+
170+
[<img alt="Deployed with web deploy" src="https://img.shields.io/badge/Deployed With-web deploy-%3CCOLOR%3E?style=for-the-badge&color=d00000">](https://github.com/SamKirkland/web-deploy)
171+
172+
```md
173+
[<img alt="Deployed with web deploy" src="https://img.shields.io/badge/Deployed With-web deploy-%3CCOLOR%3E?style=for-the-badge&color=d00000">](https://github.com/SamKirkland/web-deploy)
174+
```
175+
176+
---
177+
178+
[<img alt="Website Deployed for Free with web deploy" src="https://img.shields.io/badge/Website deployed for free with-web deploy-%3CCOLOR%3E?style=for-the-badge&color=297FA9">](https://github.com/SamKirkland/web-deploy)
179+
180+
```md
181+
[<img alt="Website Deployed for Free with web deploy" src="https://img.shields.io/badge/Website deployed for free with-web deploy-%3CCOLOR%3E?style=for-the-badge&color=297FA9">](https://github.com/SamKirkland/web-deploy)
182+
```
183+
184+
[<img alt="Website Deployed for Free with web deploy" src="https://img.shields.io/badge/Website deployed for free with-web deploy-%3CCOLOR%3E?style=for-the-badge&color=2b9348">](https://github.com/SamKirkland/web-deploy)
185+
186+
```md
187+
[<img alt="Website Deployed for Free with web deploy" src="https://img.shields.io/badge/Website deployed for free with-web deploy-%3CCOLOR%3E?style=for-the-badge&color=2b9348">](https://github.com/SamKirkland/web-deploy)
188+
```
189+
190+
[<img alt="Website Deployed for Free with web deploy" src="https://img.shields.io/badge/Website deployed for free with-web deploy-%3CCOLOR%3E?style=for-the-badge&color=d00000">](https://github.com/SamKirkland/web-deploy)
191+
192+
```md
193+
[<img alt="Website Deployed for Free with web deploy" src="https://img.shields.io/badge/Website deployed for free with-web deploy-%3CCOLOR%3E?style=for-the-badge&color=d00000">](https://github.com/SamKirkland/web-deploy)
194+
```
195+
154196
## FAQ
155197
<details>
156198
<summary>How to exclude .git files from the publish</summary>

‎action.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "web deploy"
1+
name: "web deploy anything"
22
description: "Deploy websites via sftp/ssh/rsync"
33
author: "Sam Kirkland"
44
inputs:
@@ -26,7 +26,7 @@ inputs:
2626
default: "--archive --verbose --compress --human-readable --progress --delete-after --exclude=.git* --exclude=.git/ --exclude=README.md --exclude=readme.md --exclude=.gitignore"
2727
required: false
2828
runs:
29-
using: "node12"
29+
using: "node16"
3030
main: "dist/index.js"
3131
branding:
3232
icon: "upload-cloud"

‎dist/index.js‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3437,6 +3437,13 @@ var errorDeploying = "\u26A0\uFE0F Error deploying";
34373437
async function run() {
34383438
try {
34393439
const userArguments = getUserArguments();
3440+
console.log(`----------------------------------------------------------------`);
3441+
console.log(`\u{1F680} Thanks for using web deploy. Let's deploy some stuff!`);
3442+
console.log(`----------------------------------------------------------------`);
3443+
console.log(`If you found this project helpful, please support it`);
3444+
console.log(`by giving it a \u2B50 on Github --> https://github.com/SamKirkland/web-deploy`);
3445+
console.log(`or add a badge \u{1F3F7}\uFE0F to your projects readme --> https://github.com/SamKirkland/web-deploy#badge`);
3446+
console.log(`----------------------------------------------------------------`);
34403447
await verifyRsyncInstalled();
34413448
const privateKeyPath = await setupSSHPrivateKey(userArguments.private_ssh_key);
34423449
await syncFiles(privateKeyPath, userArguments);

‎src/main.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ async function run() {
1414
try {
1515
const userArguments = getUserArguments();
1616

17+
console.log(`----------------------------------------------------------------`);
18+
console.log(`🚀 Thanks for using web deploy. Let's deploy some stuff!`);
19+
console.log(`----------------------------------------------------------------`);
20+
console.log(`If you found this project helpful, please support it`);
21+
console.log(`by giving it a ⭐ on Github --> https://github.com/SamKirkland/web-deploy`);
22+
console.log(`or add a badge 🏷️ to your projects readme --> https://github.com/SamKirkland/web-deploy#badge`);
23+
console.log(`----------------------------------------------------------------`);
24+
1725
await verifyRsyncInstalled();
1826
const privateKeyPath = await setupSSHPrivateKey(userArguments.private_ssh_key);
1927
await syncFiles(privateKeyPath, userArguments);

0 commit comments

Comments
 (0)