Add documentation about installation using Homebrew

[stloyd]

Change Log

Added

• Add documentation about installation using Homebrew
• Add Homebrew formula into monorepo

Fixed

Changed

Removed

Deprecated

Security

---

Description

Example (commit message adjusted in PR):

[norberttech]

Ok, so here is my position on this.

As much as I would love to keep it like that, there is one serious problem with the approach of keeping brew formula outside of the monorepo. Outside repo means another step in the release process, which I would prefer to keep as simple as possible.

We have the following options here:

• find a way to make it a part of the mono repo and automate the release process
• open PR to brew official distro
• properly document the release process of ETL

The official distro also means manually opening PR's after every release, but at least users wont need to add custom taps to brew.
Personally, I would go with option number one, automating update of formula file after release build is done, should not be very hard.

[norberttech]

Could you, just one last time, on your fork, mark a new release and test this whole build-release workflow before I merge this and release new version?

[stloyd]

@norberttech Here:

• the commit: stloyd@32c9bc5
• the release action: https://github.com/stloyd/flow/actions/runs/7104378394/job/19339754055

On my fork the main difference was old comment + usage of my fork in all URLs.

When you approve this PR I will rebase and remove the commit from the PR.

[norberttech]

Looks good, any idea why on hour 0.5.6 version there is no signed phar?
Also, are there any concerns about the repo split? Will that additional commit trigger another split after marking a new release?

[stloyd]

1. I have disabled sign of phar as I didn't setup it on my fork, it will not affect anything as it uses the phar file only,
2. Split should be executed normally as this would be a new commit to 1.x branch, so it should be propagated to the flow-php/homebrew-flow repository

[norberttech]

yeah, but what about the version of the tap repo? Could you maybe explain step by step what will happen once release is published? I mean which workflows will
be executed and in what order?

[stloyd]

1. Release trigger will start build workflow,
2. Build workflow does phar, uploads it on release tag artifact, at end will trigger new commit to main branch with update of formula file with details of new phar,
3. New commit will trigger split on mono-repository pointing to homebrew-flow as above commit will land in that package,
4. Done.

The only consideration here can be changelog update being triggered on commit to update formula. Probably we should add that path to ignore, like:

Subject: [PATCH] Add homebrew formula into monorepo
---
Index: .github/workflows/automation-changelog-update.yml
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/.github/workflows/automation-changelog-update.yml b/.github/workflows/automation-changelog-update.yml
--- a/.github/workflows/automation-changelog-update.yml	(revision 8e9db5ec94ef1f2262485104d3160eec2f0282d4)
+++ b/.github/workflows/automation-changelog-update.yml	(date 1701802523024)
@@ -4,6 +4,9 @@
   workflow_dispatch:
   push:
     branches: [ 1.x ]
+    paths-ignore:
+      # Ignore updates of Homebrew formula in CHANGELOG
+      - 'src/tools/homebrew/Formula/flow-php.rb'
 
 jobs:
   automation:

[norberttech]

The only consideration here can be changelog update being triggered on commit to update formula. Probably we should add that path to ignore, like:

I think that's fine. It will be a single entry after each release.

[norberttech]

Ping me when it's ready to merge, will push another release after