thinktandem / template-drupal8 Goto Github PK

Let's keep this simple and stupid for now until we have this start state integrated into our forthcoming engineering process eg it has a budget.

Porting old files

We need to move a bunch of shit from
https://github.com/thinktandem/deprecated-platformsh-example-drupal8

• Landofiles
• Travisfiles
• Codeclimate files
• Lando settings.php file
• Lets get some github PR/issue templates rolling (you can look at Lando as a starting point)

README

• We want to move our README from https://github.com/thinktandem/deprecated-platformsh-example-drupal8 but we also do not want to lose the upstream one.

Is there a clever way to take advantage of

If you put your README file in your repository's root, docs, or hidden .github directory, GitHub will recognize and automatically surface your README to repository visitors.

from https://help.github.com/articles/about-readmes/ to have BOTH readmes in our repo but with our showing as project default?

Using new Landofiles

• In the newest version of Lando you can set a "base" file that can then be overridden by the usual .lando.yml
  https://docs.devwithlando.io/config/lando.html#base-file

We should probably do that there, and might be able to use this for our Travis landofile as well.

• See if we can use .lando.base.yml to replace .travis.lando.yml

Spin up some botz

We should add config for various bots so we can get all the automation out of the box. Check out https://github.com/lando/lando/tree/master/.github for a few but we should include config for the following:

• https://probot.github.io/apps/stale/
• https://probot.github.io/apps/delete-merged-branch/
• https://probot.github.io/apps/ci-reporter/

DevOps

• Get a platform.sh site
• Get Travis things running

Get Testing Working / Config Testing in Travis

• PHP Lint
• PHP Codesniff
• PHP Unit
• Drupal 9 Deprecation

Future things

• Some sort of "bootup" script so a user can git clone the start state and then spin up all the needed devops eg platform/github/travis/circle/codeclime etc (Optional for now)
• Some way to automatically submit pull requests when upstream updates are available, fork the "Pull Bot"

You're using platform SSH keys in your travis yml in order to get the platform db dump. You don't need to - it works fine with the API token which is way simpler and the way platform.sh recommend handling this on CI.

Hey guys,

Thanks for setting this up! Just wanted to give you a heads up that the settings.local.php file is missing from the repo.

Thanks!
Rob

I think it would be great for you to write a V2 of
https://thinktandem.io/blog/2017/10/23/killer-d8-workflow-using-lando-and-platform-sh/

To that end i think we want to add in a few extra things, some of which you can steal directly from proof of concept work ive done over here
https://github.com/lando/website

Good to read
https://docs.devwithlando.io/config/tooling.html#options-driven-tooling

• We want a lando setup command that will spin up and set up the Platform.sh site, set up GitHub integration etc. I have this working over at https://github.com/lando/website
• We need to augment that command so that it also initializes and sets up Travis, guessing we can install the travis cli in a ruby container on the lando side to do that, when you merge this into lando setup you will probably want to move to this https://docs.devwithlando.io/config/tooling.html#multi-service-multi-command-tooling
• We want to define some sort of lando pull command so we can easily pull in databases and mounts from platform. You should be able to do this following the model of lando setup
• We need to write out the manual steps the user needs to take from forking the site to being able to dev, ill detail those steps below

Manual Steps

We need to document these better, what is below is just a sketch

1. User forks project
2. User clones project
3. User runs lando init --recipe=d8 --webroot=... to override the base.yml file with something named better.
4. User runs lando start
5. User manually gets required GITHUBTOKEN and PLATFORMTOKEN, note that if you are an agency you want to get the token for the agency owner
6. User runs lando setup
7. User manually turns on github branch protection for master and sets it up as needed, for us this SHOULD include enforced code review and enforced passing of status checks
8. User should set up bots like stale/delete merged pr and codeclimate
9. User should modify the new projects readme with any additional considerations for this project

@labboy0276 am i missing any other good steps there?

Bonus Task

Right now we have no way to handle an error in the middle of the setup process, which means that we could end up with a Platform.sh project spun up without the other magic and no real way to address that beyond manually deleting it through the p.sh UI. I think what we want to do is catch any error that happens during the setup process (check out how to use "traps" in bash) and

1. Inform the user that an error has occured
2. Inform the user that we are rolling things back eg deleting the half baked platform instance
3. Actually deleting the half backed platform instance

As a Tandem developer
I want to be able to lint my Drupal code
So that I can always ensure my code follows the Drupal coding standard