automattic / vip-go-build

A build script for VIP Go

VIP Go CI Build Scripts

This directory contains various scripts to handle a build process for the VIP Go hosting platform on WordPress.com VIP.

Learn More.

Credits

Inspiration (and some code) taken from Human Made's VIP Go Builder, thank you!

vip-go-build's Issues

Git submodules always get updated

It's not possible to specify a commit other than the latest for a git submodule, it always gets updated to the latest available commit when deployed

fixed by #18

Files deleted from the deploy branch don't get removed from the built branch

Expected

Files in the built branch should only contain the files in the deploy branch + anything created by the CI process.

Steps to reproduce

1. You will need to use a test site that has CIrcleCI configured to call deploy.sh or you can setup ENV variables locally and call deploy.sh directly.
2. Remove a folder/file from the deploy branch and commit/push. Either wait for CircleCI to run/push or run deploy.sh
3. Observe the file/folder is still present in the built repository.

Split script into `prepare` and `deploy`

Something to consider for the future:

• prepare would detect the environment, assemble the necessary data, and then pass them to the deploy.
• deploy would be environment-agnostic and accept args for src / dest / branches / etc.

The biggest benefit of this would be to simplify running a deploy locally (e.g. emergency situations where the CI service is down or too slow)

Fixme note for apt-get update

In the deploy script, there is:

vip-go-build/deploy.sh

Lines 97 to 99 in 77d4708

	# @FIXME Probably there's a way we could check if APT is up to date or not
	# so we don't have to run update every time
	sudo apt-get update

There's a timestamp file that could be checked to see if it exists, but I'm not sure that on a fresh environment spun up by the CI service whether it is worth checking this exists (and what would the timestamp value be compared to?) vs just running the update.

• Circle CI have a Ruby custom environment example which shows several instances of sudo apt-get update.
• Travis CI has similar example documentation with the same command.

Adding this issue (even if it's immediately closed / the Fixme note removed) for future reference.

Link in the README is 404ing

Do you want to change it to https://github.com/Automattic/vip-go-skeleton/blob/add/ci-deploy/README-BUILD-SCRIPT.md, or will you expect it to auto-update with merging?

Set up new Travis CI app for this repo

The "legacy" method of adding repos is now deprecated. I think this work depends on setting it up for the whole Automattic repo, so this needs coordinating with other teams.

https://blog.travis-ci.com/2018-05-02-open-source-projects-on-travis-ci-com-with-github-apps

Add "deployignore" type capability to build script

The problem:
.gitignore files that a client developer is excluding from the repo often overlap with -built files.
For example, while ignoring a node_modules directory is necessary for both development and deployment, the client would want the build directory included in the actual -built branch for deployment.

The solution:
Per internal discussion, there are multiple approaches... which one is less confusing for clients of all skill levels and less likely to cause issues?

• stripping a section from .gitignore
• using a .deployignore to specify a different ignore list for deploys
• using a .deploykeep to flag a directory structure that gets deployed
• something else?

It's time we make one of these for github actions

Just saying... ❤️

Make deploy script compatible with GitHub Actions

If we can make our deploy.sh script work with GitHub Actions and simplify our setup for working on Circle CI or Travis, that would be great.

props @mjangda