Introducing the Gitify workflow toolkit for MODX, talking about the different needs for workflow solutions, specific to the MODX CMS.

1. Dev, Staging & Production
Workflow with Gitify
Mark Hamstra, @mark_hamstra

2. What is a Dev/Stage/
Production Workflow?

3. What is a Dev/Stage/
Production Workflow?
• One site or project

4. What is a Dev/Stage/
Production Workflow?
• One site or project
• Replicated across separated environments, each
potentially in a completely different state

5. What is a Dev/Stage/
Production Workflow?
• One site or project
• Replicated across separated environments, each
potentially in a completely different state
• Tailored to the team, environment or business processes

6. modx.com/blog/2015/11/16/your-website-just-got-a-promotion/

7. Requirements for a workflow
that actually works

8. Requirements for a workflow
that actually works
• Automation

9. Requirements for a workflow
that actually works
• Automation
• Automation

10. Requirements for a workflow
that actually works
• Automation
• Automation
• str_repeat(‘Automation’, PHP_INT_MAX);

11. Requirements for a workflow
that actually works
• Automation
• Automation
• str_repeat(‘Automation’, PHP_INT_MAX);
• Accessible to the different stakeholders

12. Requirements for a workflow
that actually works
• Automation
• Automation
• str_repeat(‘Automation’, PHP_INT_MAX);
• Accessible to the different stakeholders
• Easy to rollback

13. Requirements for a workflow
that actually works
• Automation
• Automation
• str_repeat(‘Automation’, PHP_INT_MAX);
• Accessible to the different stakeholders
• Easy to rollback
• Able of dealing with conflicting changes

14. To be able of replicating
environments and automating a
workflow, you need a single
source of truth.

15. How to deal with all of this?

16. How to deal with all of this?
Git!

17. How to deal with all of this?
Git!
• Manages state of files

18. How to deal with all of this?
Git!
• Manages state of files
• Can handle conflicts automatically + manually

19. How to deal with all of this?
Git!
• Manages state of files
• Can handle conflicts automatically + manually
• Easy to automate through simple CLI api

20. How to deal with all of this?
Git!
• Manages state of files
• Can handle conflicts automatically + manually
• Easy to automate through simple CLI api
• Can be made more accessible through GUI clients
and services (like GitHub)

21. To be able of replicating
environments and automating a
workflow, the git repository needs
to be the single source of truth.

22. How to deal with all of
this…on a MODX project?

23. How to deal with all of
this…on a MODX project?
• Store assets, custom components and relevant files in git

24. How to deal with all of
this…on a MODX project?
• Store assets, custom components and relevant files in git
• … missing the important bits!
• Content
• Elements (templates,TVs, chunks, snippets, plugins)
• Other information stored in the database

25. How do we get information
in our database into a
format that unlocks the
potential of git?

26. Gitify!

28. What is Gitify?
• Command line toolkit
• Written with Symfony 2 Console

29. What can Gitify do?

30. What can Gitify do?
• Write information from the database to files
Gitify extract

31. What can Gitify do?
• Write information from the database to files
Gitify extract
• Write information from those files into the database
Gitify build

33. Built-in magic

34. Built-in magic
• Automatic ID conflict resolution

35. Built-in magic
• Automatic ID conflict resolution
• Automatic orphan cleanup

36. Gitify bridges the gap
between the database and
your git repository

37. Project Configuration
• .gitify file in root of project
• Specifies data
• Specifies packages to install

40. So how does the
workflow work?

41. Different environments have
different workflow needs.

42. Putting it together
Git
- develop
- staging
- production
localhost
stage.site.com
site.com

43. Dev Workflow
Make changes in MODX
Run `Gitify extract`
Commit to repository
and push

44. File-based Dev Workflow
Make changes in Data Files
Run `Gitify build`
Test changes in MODX
Commit to repository
and push

45. Putting it together
Git
- develop
- staging
- production
localhost
stage.site.com
site.com
manual

46. Staging Workflow
Editor team makes
content changes in MODX
Automatically extracted
Automatically committed
to staging branch
Automatically pushed

47. Putting it together
Git
- develop
- staging
- production
localhost
stage.site.com
site.com
manual
automated

48. Production Workflow
Don’t make changes on production

49. Production Workflow
Don’t make changes on production
(or use the same workflow as staging if you must)

50. Production Workflow
Don’t make changes on production
(or use the same workflow as staging if you must)
(but really, you shouldn’t)

51. Setting automatic
deployments

53. Deploying with Gitify
• git fetch origin
• git reset --hard %COMMIT%
• git pull origin %BRANCH%
• Gitify backup deploy_%TIMESTAMP_UTC%
• # Gitify package:install --all
• Gitify build

54. Creating new environments

55. Creating new environments
1. Clone the repository

56. Creating new environments
1. Clone the repository
2. Install MODX (Gitify modx:install)

57. Creating new environments
1. Clone the repository
2. Install MODX (Gitify modx:install)
3. Install dependent packages (Gitify package:install —
all)

58. Creating new environments
1. Clone the repository
2. Install MODX (Gitify modx:install)
3. Install dependent packages (Gitify package:install —
all)
4. Build the data (Gitify build [--force])

59. Putting it together
Git
- develop
- staging
- production
localhost
stage.site.com
site.com
manual
automated
automated

60. But how do we
automatically extract,
commit and push?

61. Introducing Gitify Watch

63. X

64. Gitify Watch

65. Gitify Watch
• Works with Scheduler

66. Gitify Watch
• Works with Scheduler
• Triggers on saving resources and elements

67. Gitify Watch
• Works with Scheduler
• Triggers on saving resources and elements
• Automatically extracts, commits & pushes data

70. Gitify Watch

71. Gitify Watch
• Free

72. Gitify Watch
• Free
• github.com/modmore/GitifyWatch

73. Gitify Watch
• Free
• github.com/modmore/GitifyWatch
• Package via modmore.com before holidays

74. Gitify can do more!

75. Install & Upgrade MODX
Gitify modx:install [version]
Gitify modx:upgrade [version]

76. Install MODX packages
Gitify package:install [name] [--version]

77. Backup & Restore
Gitify backup [name]
Gitify restore [name]

78. Links & More Info
• Source: github.com/modmore/Gitify
• Docs: github.com/modmore/Gitify/wiki and modmore.github.io/Gitify/
• GitifyWatch: github.com/modmore/GitifyWatch
• Example Gitify projects:
• github.com/modmore/MODX.today
• github.com/modmore/demo.modmore.com

79. Thank you
@mark_hamstra - @modmore
markhamstra.com - modmore.com