sunnysideup/release

Auto-release latest version of a branch.

Installs: 619

Dependents: 2

Suggesters: 0

Security: 0

Stars: 2

Watchers: 3

Forks: 0

Open Issues: 0

Language:Shell

Type:silverstripe-vendormodule

1.5.0 2023-11-21 23:55 UTC

This package is auto-updated.

Last update: 2024-04-30 00:45:40 UTC


README

This module helps you release your silverstripe (or other) projects.

install

composer require sunnysideup/release:dev-master

release script usage

This module comes with an opiniated release script that can be used as follows:

try it...

vendor/bin/sake-release -h

additional settings

To skip flushing the front-end, set the following variable in your .env file:

SS_RELEASE_FRONT_END=false

speed up DEV/BUILD

To speed up the dev/build, you can add the following to your .env file:

SS_FAST_DEV_BUILD=true

Below are some further notes about release strategies

Building a Deployment Strategy / Pipeline

Here are some general notes about releases. Use as you see fit.

requirements

release should be easy ....

  • Whenever you push to a designated branch, it releases on a server (test / production).
  • We are able to roll back (db + code)
  • Releases should be fast

option 1 - use bitbucket hook with this module.

Here is how:

set up .env variables

set:

  • SS_RELEASE_TOKEN="ABC_ABC_ABC_ABC_ABC_ABC_ABC_ABC_" # set to a random string
  • SS_RELEASE_SCRIPT="vendor/bin/sake-release"

in your .env file.

finally

add a hook to bitbucket:

https://mysite.co.nz/_resources/vendor/sunnysideup/release/client/ReleaseProjectFromBitbucketHook.php?ts=ABC_ABC_ABC_ABC_ABC_ABC_ABC_ABC

See https://confluence.atlassian.com/bitbucketserver/using-repository-hooks-776639836.html

option 2 - use BEAM

See https://github.com/heyday/beam/

option 3 - use bitbucket pipepline with this module

a. enable pipelines: https://bitbucket.org/yourorganisation/yourproject/admin/addon/admin/pipelines/settings (see settings / pipelines / settings)
b. create ssh key on bitbucket.com (settings > pipelines > ssh keys)
c. add public ssh key to server in ~/.ssh/authorized_keys (or through a control panel)
d. write file below as bitbucket-pipelines.yml in the root of your project
pipelines:
  branches:

    development:
      - step:
          script:
            - ssh -o StrictHostKeyChecking=no bitbucket@111.222.333.444 'cd ./var/www/mysite; bash vendor/bin/sake-release develop'

    master:
      - step:
          script:
            - ssh -o StrictHostKeyChecking=no bitbucket@111.222.333.444 'cd ./var/www/mysite; bash vendor/bin/sake-release production'

example pipelines with extra stuff:

https://github.com/brettt89/silverstripe-docker

Option 4: use https://deployer.org/