Project

spectre-git

0.0
The project is in a healthy, maintained state
spectre-gitionos-spectre/spectre-gitHomepageDocumentationSource CodeBug TrackerWiki
Adds basic git commands to the spectre framework
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Popularity
Downloads
7,474
Stars
0
Forks
0
Watchers
2
 Releases
Current version
2.0.0
Total releases
5
First release
2021-06-02
Latest release
2025-03-21
 Development
Primary Language
Ruby
Licenses
GPL-3.0-or-later
Average date of last 50 commits
2022-10-04
Reverse Dependencies
0

 Dependencies

Runtime

logger
>= 0
stringio
>= 0
 Project Readme

Spectre Git

Build Gem Version

This is a spectre module which provides some basic git commands for use with spectre.

Install

$ sudo gem install spectre-git

Configure

Add the module to your spectre.yml

include:
 - spectre/git

Configure some predefined Git access options in your environment file

git:
  example:
    url: https://some-git.com/path/to/repo/example.git
    username: dummy
    password: '*****'

Usage

Use the git helper method to access a git repository by providing a valid Git URL as a parameter.

git 'https://some-git.com/path/to/repo/example.git' do
  username 'dummy'
  password '*****'

  branch 'main'
  clone

  # Do some file editing
  file_content = read_file('path/to/file')
  file_content = file_content.to_i + 1

  write_file('path/to/file', file_content)

  add 'path/to/file'
  # add_all # Same as git add --all
  commit 'some changes made'
  push
end

# When already connected to a repository, you can ommit the parameter to use the last Git access configuration
git do
  add 'path/to/other_file'
  commit 'another change'
  push
end

With a preconfigured Git access use the given name as a parameter

git 'example' do
  clone

  # Do some file editing

  add 'path/to/file'
  commit 'some changes made'
  push
end

Functions

The following functions are available within the git block.

Method Arguments Multiple Description
username string no The username for Git authentication
password string no The password for Git authentication
branch string no The Git branch to operate on. If omitted, master will be used.
clone none no Clones the configured repository
add string yes Adds a file to the stage. git add <file_path>
add_all none no Adds all files to the stage. git add --all
tag string no Add an annotated tag. git tag -a -m <message>
commit string yes Creates a new commit with the given message. git commit -m '<message>'
push none no Adds a file to the stage. git push
read_file string yes Reads the content of a file within the local Git repository. Given path is relative to checkout directory. Returns the file content.
write_file string, string yes Writes the given content to a file within the local Git repository. Given path is relative to checkout directory.
cleanup none no Deletes the cloned repository.
run string yes Run a custom command within the Git repository directory