Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dieterholvoet/gitlab-ci-deploy
Reusable config for simple, SSH based deploys using GitLab CI
https://github.com/dieterholvoet/gitlab-ci-deploy
deployment deployment-automation dotenv gitlab-ci
Last synced: 7 days ago
JSON representation
Reusable config for simple, SSH based deploys using GitLab CI
- Host: GitHub
- URL: https://github.com/dieterholvoet/gitlab-ci-deploy
- Owner: DieterHolvoet
- License: mit
- Created: 2020-04-14T09:50:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-12T23:14:44.000Z (about 1 year ago)
- Last Synced: 2024-10-12T02:23:51.899Z (about 1 month ago)
- Topics: deployment, deployment-automation, dotenv, gitlab-ci
- Size: 46.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
gitlab-ci-deploy
======================
> Reusable config for simple, SSH based deploys using [GitLab CI/CD]((https://docs.gitlab.com/ee/ci)).
## Requirements
- A server with SSH access, bash & rsync
- A repository hosted on Gitlab with the following files: `.gitlab-ci` and
`.deploy/.rsync-filter`. The [examples](#examples) can be used for
inspiration.
## Features
### Run pipelines using GitLab CI/CD
All this functionality is powered by **GitLab CI/CD**, check their
[documentation](https://docs.gitlab.com/ee/ci/) for more information.
### Deploy your files using rsync
The deployment of your files is done using
[rsync](http://manpages.ubuntu.com/manpages/eoan/en/man1/rsync.1.html):
- One-way sync, left to right
- Extraneous files are deleted from destination dirs
- Filter rules can be defined in the `.deploy/.rsync-filter` file.
To minimise downtime, the file sync will happen to a copy of your files
in a new _release_. After finishing the sync, the active release will be
changed by replacing the symlink. A couple of settings can be changed
through variables:
- `RELEASES_FOLDER`: the name of the folder in which all releases are
stored (default: `releases`)
- `CURRENT_RELEASE_FOLDER`: the name of the folder to which the active
release is symlinked (default: `current`)
- `KEEP_RELEASES`: the amount of releases that should be kept (minimum: 1,
default: 2)
A couple environment variables are required, check the [documentation](https://docs.gitlab.com/ee/ci/variables/) for ways to define them.
- `DEPLOY_SERVER_HOST`: the host of the server
- `DEPLOY_SERVER_USER`: the user used for SSH'ing
- `DEPLOY_SSH_PRIVATE_KEY`: the private key used for SSH'ing
- `DEPLOY_PATH`: the path the files should be deployed to
### Run a server-side script after deploy
If a `.deploy/post-deploy.sh` file exists, it will be executed on the
server after the deployment is finished. The current directory will be
equal to `DEPLOY_PATH`.
### Automatically generate .env files
A script is provided to automatically generate a .env file and serve it as
an artifact in your pipeline. To add this functionality to your pipeline,
create a new job extending `.create_dotenv`:
```yaml
dotenv:
extends:
- .create_dotenv
stage: build
```
The script will take a `.env.example` file as starting point and fill in
the values using current environment variables. There are multiple ways
to define your environment variables, check the
[documentation](https://docs.gitlab.com/ee/ci/variables/) for more
information.
### Create a Sentry release
A script is provided to create a new Sentry release. To add this functionality to your pipeline,
create a new job extending `.create_sentry_release` and make sure `SENTRY_AUTH_TOKEN`, `SENTRY_DSN`, `SENTRY_ORG` and
`SENTRY_PROJECT` are available as environment variables. Please refer to the
[Sentry CLI docs](https://docs.sentry.io/product/cli/configuration/#configuration-values) for more information.
## Examples
Some examples are provided to get you started quickly.
### [`deploy-only`](examples/deploy-only)
- simple, deploy-only setup
### [`drupal-8`](examples/drupal-8)
- Drupal 8 website
- jobs for building a custom theme, .env file, installing Composer dependencies and creating a Sentry release after deploying
- a set of Drush commands are executed after deploying.
### [`octobercms`](examples/octobercms)
- OctoberCMS website
- jobs for building a custom theme, .env file and installing Composer dependencies
- a set of Artisan commands are executed after deploying.
- staging environment which is automatically built and deployed after pushing to a [Gitflow-style](https://nvie.com/posts/a-successful-git-branching-model) release branch
- production environment which is automatically built, but manually deployed after pushing a [Semantic Versioning-style](https://semver.org) tag.