Socios Homebrew Formula

Homebrew Formula

The Homebrew tap/formula process is the combination of two GitHub repositories.

The First GitHub repo contains the functionality package (socios).

The second GitHub repo contains the homebrew formula with the ruby file (homebrew-socios).

Step1: Creating Tag and Releases

We need to clone the First repository(socios) in a specific path. Using the below Git clone command

$ git clone https://github.com/SociOS-Linux/socios.git

Switch into that cloned repository folder(socios) then we need to place the updated script packages in that folder(socios).

By using the git commands. We need to push the updated files to the First repository(socios)

$ git status && git branch

$ git add .

$ git commit -am "socios: Updated to the latest version <MAJOR.MINOR.PATCH>"

For every commit, we need to update the commit message.

	$ git push -u origin main //  git push -u origin develop

	$ git tag v<MAJOR.MINOR.PATCH>

	$ git push origin v<MAJOR.MINOR.PATCH>

Once we push the tag into the First repository(socios). Refresh the Repository once.

Then we can able to view the changes in the Releases option.

Now, Click on the latest update tag

We can able to view the old releases here. Now we need to click on “Release”

Then we can able to access the “Tag” section. Click on Tag

Here we can able to see the Updated build file with (zip, Tar.gz) formate

Now select the Release tab. Click on the Draft a new release button

Next, we need to choose the “Tag” with (Latest version) and the target branch

Update the Release title with “Version Name” with Description

Now un-check the pre-release and click on “Publish release”

Finally, We can able the see the latest release in the socios repository

Step2: Creating Homebrew Tap/Formula

Already we have a package zip and tar.gz file in our First repository(socios)

Right-click the Filename(Source code (tar.gz)) - Now Copy the latest version of the tar.gz package file URL

We can able to find the socios package file based on it's tags <MAJOR.MINOR.PATCH> here:

https://github.com/SociOS-Linux/socios/archive/refs/tags/v<MAJOR.MINOR.PATCH>.tar.gz

we need to copy the socios package compressed tar.gz file link from the GitHub release.

Create the ruby file formula by running the below command in the terminal.

Syntax: brew create

$ brew create https://github.com/SociOS-Linux/socios/archive/refs/tags/v<MAJOR.MINOR.PATCH>tar.gz

Notes: If there is an existing version configured in mac Machine we need to untap the previous version.

$ brew uninstall socios
$ brew untap  SociOS-Linux/socios

The above command will generate the default formula file in a ruby format for our socios packages

Once created homebrew editor will open - we need to exit the editor terminal (:wq)

Now the Updated formula is created in the below file location.

     /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/socios.rb

Homebrew Directory list

      Homebrew package uses the below folder's path to configuration.

Formula – The package definition uses the path /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/socios.rb

Keg - The installation prefix of a Formula uses the path /usr/local/Cellar/socios/v1.3.6

Cellar - All Kegs are installed in path /usr/local/Cellar

Tap - A Git repository of Formulae and/or commands uses the path /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core

Step3: Creating Second Repository for Homebrew Formula/ Socios

Create a second repository(sociosbrew-tap) for the ruby formula.

Then clone that repository in our local System using the below git clone command.

$ git clone https://github.com/SociOS-Linux/sociosbrew-tap.git

After we clone the repository - Switch to the sociosbrew-tap folder.

Now we need to update the socios.rb file with some functions.

Copy the default socios.rb file with cloned repository folder (sociosbrew-tap)

$ cp /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/socios.rb .

Using nano command. We need to update the socios.rb file using the below Line.

Syntax:
     def install
              bin.install "socios"
              prefix.install Dir["lib"]
     end
end

Then we need to commit the updated file to Second Repository (sociosbrew-tap)

Check the branch and status using the git commands.

$ git status && git branch

Check the changes in the file using the below terminal

$ git diff 

It will show changes between commits, commit, and the working tree

$ git add .
 
$ git commit -m “Socios: Updated version <tags>”
 
$ git push -u origin main / git push -u origin develop

Once committed the file we need to refresh the GitHub page

Once completed the above procedures, we can able to download and use our socios packages by using the below commands.

Then we can check the functions of Socios using the below commands.

$ brew tap SociOS-Linux/socios 

         $ brew install socios

         $ socios --version

Steps to uninstall socios

$ brew uninstall socios