Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pforret/gitploy

Deploy website/app through git (both push from dev and pull to prod)
https://github.com/pforret/gitploy

deployment git

Last synced: 24 days ago
JSON representation

Deploy website/app through git (both push from dev and pull to prod)

Host: GitHub
URL: https://github.com/pforret/gitploy
Owner: pforret
License: mit
Created: 2023-05-11T12:20:18.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2023-09-29T09:32:04.000Z (over 1 year ago)
Last Synced: 2024-11-14T06:36:22.818Z (3 months ago)
Topics: deployment, git
Language: Shell
Homepage:
Size: 467 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        ![bash_unit CI](https://github.com/pforret/gitploy/workflows/bash_unit%20CI/badge.svg)

![Shellcheck CI](https://github.com/pforret/gitploy/workflows/Shellcheck%20CI/badge.svg)

![GH Language](https://img.shields.io/github/languages/top/pforret/gitploy)

![GH stars](https://img.shields.io/github/stars/pforret/gitploy)

![GH tag](https://img.shields.io/github/v/tag/pforret/gitploy)

![GH License](https://img.shields.io/github/license/pforret/gitploy)

[![basher install](https://img.shields.io/badge/basher-install-white?logo=gnu-bash&style=flat)](https://www.basher.it/package/)

# gitploy

deploy websites

## 🔥 Usage

```

Program : gitploy  by [email protected]

Version : v0.2.0 (2023-09-27 18:34)

Purpose : deploy websites

Usage   : gitploy [-h] [-q] [-v] [-f] [-A] [-l ] [-t ] [-F ] [-H ] [-J ] [-L ] [-M ] 

Flags, options and parameters:

    -h|--help        : [flag] show usage [default: off]

    -q|--quiet       : [flag] no output [default: off]

    -v|--verbose     : [flag] also show debug messages [default: off]

    -f|--force       : [flag] do not ask for confirmation (always yes) [default: off]

    -A|--automatic   : [flag] always check in/out everything [default: off]

    -l|--log_dir > : [option] folder for log files   [default: /home/pforret/log/gitploy]

    -t|--tmp_dir > : [option] folder for temp files  [default: /tmp/gitploy]

    -F|--FRAMEWORK >: [option] laravel/mkdocs/jekyll/hugo (default: autodetect))

    -H|--HUGO_PORT >: [option] hugo runs on port  [default: 1313]

    -J|--JEKYLL_PORT >: [option] jekyll runs on port  [default: 8000]

    -L|--LARAVEL_PORT >: [option] laravel runs on port  [default: 8000]

    -M|--MKDOCS_PORT >: [option] mkdocs runs on port  [default: 4000]

             : [choice] action to perform  [options: push,pull,install,serve,check,env,update]

                                  pforret:pforret/gitploy.git

### TIPS & EXAMPLES

* use gitploy push to push code changes to GitHub/Bitbucket

  gitploy push

  gitploy -A push (automatic: push new files too)

  gitploy -F laravel push (also run build scripts for laravel)

* use gitploy pull to pull code changes from GitHub/Bitbucket

  gitploy pull

* use gitploy install to install project dependencies (run first time)

  gitploy install

* use gitploy pull to serve website

  gitploy pull

* use gitploy check to check if this script is ready to execute and what values the options/flags are

  gitploy check

* use gitploy env to generate an example .env file

  gitploy env > .env

* use gitploy update to update to the latest version

  gitploy update

* >>> bash script created with pforret/bashew

* >>> for bash development, also check out pforret/setver and pforret/progressbar

```

## ⚡️ Examples

```bash

> gitploy push 

> gitploy pull

> gitploy -A push

> gitploy -F laravel push 

# get extended usage info

> gitploy env > .env

# create a .env file with default values

```

## 🚀 Installation

with [basher](https://github.com/basherpm/basher)

	$ basher install pforret/gitploy

or with `git`

	$ git clone https://github.com/pforret/gitploy.git

	$ cd gitploy

## 📝 Acknowledgements

* script created with [bashew](https://github.com/pforret/bashew)

© 2023 Peter Forret