Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add _log and _set_github_output functions #273

Merged
merged 9 commits into from
Dec 22, 2022
Merged

Add _log and _set_github_output functions #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b7a3dd9
Add _set_github_output function
stefanzweifel Dec 22, 2022
2996cba
Use _set_github_output in Action
stefanzweifel Dec 22, 2022
f83064a
Add _log function
stefanzweifel Dec 22, 2022
1aebb93
Use _log in Action and fix Test Cases
stefanzweifel Dec 22, 2022
404009a
Update wording in log messages
stefanzweifel Dec 22, 2022
48f54e7
Update note about removal of old output syntax
stefanzweifel Dec 22, 2022
5984e60
Test if info logs works
stefanzweifel Dec 22, 2022
5a4cb74
Use Notice instead of Log
stefanzweifel Dec 22, 2022
9d8065a
Remove “notice” log
stefanzweifel Dec 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
79 changes: 36 additions & 43 deletions entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,34 @@ if "$INPUT_DISABLE_GLOBBING"; then
set -o noglob;
fi

_set_github_output() {
local name=${1}
local value=${2}

# Check if $GITHUB_OUTPUT is available
# (Feature detection will be removed in spring 2023)
if [ -z ${GITHUB_OUTPUT+x} ]; then
echo "::set-output name=$name::$value";
else
echo "$name=$value" >> $GITHUB_OUTPUT;
fi
}

_log() {
local level=${1}
local message=${2}

echo "::$level::$message";
}

_main() {
_check_if_git_is_available

_switch_to_repository

if _git_is_dirty || "$INPUT_SKIP_DIRTY_CHECK"; then

# Check if $GITHUB_OUTPUT is available
# (Feature detection will be removed in late December 2022)
if [ -z ${GITHUB_OUTPUT+x} ]; then
echo "::set-output name=changes_detected::true";
else
echo "changes_detected=true" >> $GITHUB_OUTPUT;
fi
_set_github_output "changes_detected" "true"

_switch_to_branch

Expand All @@ -36,36 +50,22 @@ _main() {

_push_to_github
else

# Check if $GITHUB_OUTPUT is available
# (Feature detection will be removed in late December 2022)
if [ -z ${GITHUB_OUTPUT+x} ]; then
echo "::set-output name=changes_detected::false";
else
echo "changes_detected=false" >> $GITHUB_OUTPUT;
fi
_set_github_output "changes_detected" "false"

echo "Working tree clean. Nothing to commit.";
fi
else

# Check if $GITHUB_OUTPUT is available
# (Feature detection will be removed in late December 2022)
if [ -z ${GITHUB_OUTPUT+x} ]; then
echo "::set-output name=changes_detected::false";
else
echo "changes_detected=false" >> $GITHUB_OUTPUT;
fi
_set_github_output "changes_detected" "false"

echo "Working tree clean. Nothing to commit.";
fi
}

_check_if_git_is_available() {
if hash -- "$INPUT_INTERNAL_GIT_BINARY" 2> /dev/null; then
echo "::debug::git binary found.";
_log "debug" "git binary found.";
else
echo "::error ::git-auto-commit could not find git binary. Please make sure git is available."
_log "error" "git-auto-commit could not find git binary. Please make sure git is available."
exit 1;
fi
}
Expand All @@ -77,7 +77,7 @@ _switch_to_repository() {

_git_is_dirty() {
echo "INPUT_STATUS_OPTIONS: ${INPUT_STATUS_OPTIONS}";
echo "::debug::Apply status options ${INPUT_STATUS_OPTIONS}";
_log "debug" "Apply status options ${INPUT_STATUS_OPTIONS}";

echo "INPUT_FILE_PATTERN: ${INPUT_FILE_PATTERN}";
read -r -a INPUT_FILE_PATTERN_EXPANDED <<< "$INPUT_FILE_PATTERN";
Expand All @@ -91,14 +91,14 @@ _switch_to_branch() {

# Fetch remote to make sure that repo can be switched to the right branch.
if "$INPUT_SKIP_FETCH"; then
echo "::debug::git-fetch has not been executed";
_log "debug" "git-fetch will not be executed.";
else
git fetch --depth=1;
fi

# If `skip_checkout`-input is true, skip the entire checkout step.
if "$INPUT_SKIP_CHECKOUT"; then
echo "::debug::git-checkout has not been executed";
_log "debug" "git-checkout will not be executed.";
else
# Create new local branch if `create_branch`-input is true
if "$INPUT_CREATE_BRANCH"; then
Expand All @@ -114,7 +114,7 @@ _switch_to_branch() {

_add_files() {
echo "INPUT_ADD_OPTIONS: ${INPUT_ADD_OPTIONS}";
echo "::debug::Apply add options ${INPUT_ADD_OPTIONS}";
_log "debug" "Apply add options ${INPUT_ADD_OPTIONS}";

echo "INPUT_FILE_PATTERN: ${INPUT_FILE_PATTERN}";
read -r -a INPUT_FILE_PATTERN_EXPANDED <<< "$INPUT_FILE_PATTERN";
Expand All @@ -125,7 +125,7 @@ _add_files() {

_local_commit() {
echo "INPUT_COMMIT_OPTIONS: ${INPUT_COMMIT_OPTIONS}";
echo "::debug::Apply commit options ${INPUT_COMMIT_OPTIONS}";
_log "debug" "Apply commit options ${INPUT_COMMIT_OPTIONS}";

# shellcheck disable=SC2206
INPUT_COMMIT_OPTIONS_ARRAY=( $INPUT_COMMIT_OPTIONS );
Expand All @@ -140,22 +140,15 @@ _local_commit() {
--author="$INPUT_COMMIT_AUTHOR" \
${INPUT_COMMIT_OPTIONS:+"${INPUT_COMMIT_OPTIONS_ARRAY[@]}"};


# Check if $GITHUB_OUTPUT is available
# (Feature detection will be removed in late December 2022)
if [ -z ${GITHUB_OUTPUT+x} ]; then
echo "::set-output name=commit_hash::$(git rev-parse HEAD)";
else
echo "commit_hash=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT;
fi
_set_github_output "commit_hash" $(git rev-parse HEAD)
}

_tag_commit() {
echo "INPUT_TAGGING_MESSAGE: ${INPUT_TAGGING_MESSAGE}"

if [ -n "$INPUT_TAGGING_MESSAGE" ]
then
echo "::debug::Create tag $INPUT_TAGGING_MESSAGE";
_log "debug" "Create tag $INPUT_TAGGING_MESSAGE";
git -c user.name="$INPUT_COMMIT_USER_NAME" -c user.email="$INPUT_COMMIT_USER_EMAIL" tag -a "$INPUT_TAGGING_MESSAGE" -m "$INPUT_TAGGING_MESSAGE";
else
echo "No tagging message supplied. No tag will be added.";
Expand All @@ -165,7 +158,7 @@ _tag_commit() {
_push_to_github() {

echo "INPUT_PUSH_OPTIONS: ${INPUT_PUSH_OPTIONS}";
echo "::debug::Apply push options ${INPUT_PUSH_OPTIONS}";
_log "debug" "Apply push options ${INPUT_PUSH_OPTIONS}";

# shellcheck disable=SC2206
INPUT_PUSH_OPTIONS_ARRAY=( $INPUT_PUSH_OPTIONS );
Expand All @@ -175,15 +168,15 @@ _push_to_github() {
# Only add `--tags` option, if `$INPUT_TAGGING_MESSAGE` is set
if [ -n "$INPUT_TAGGING_MESSAGE" ]
then
echo "::debug::git push origin --tags";
_log "debug" "git push origin --tags";
git push origin --follow-tags --atomic ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
else
echo "::debug::git push origin";
_log "debug" "git push origin";
git push origin ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
fi

else
echo "::debug::Push commit to remote branch $INPUT_BRANCH";
_log "debug" "Push commit to remote branch $INPUT_BRANCH";
git push --set-upstream origin "HEAD:$INPUT_BRANCH" --follow-tags --atomic ${INPUT_PUSH_OPTIONS:+"${INPUT_PUSH_OPTIONS_ARRAY[@]}"};
fi
}
Expand Down
6 changes: 3 additions & 3 deletions tests/git-auto-commit.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ cat_github_output() {

assert_success

assert_line "::debug::git-fetch has not been executed"
assert_line "::debug::git-fetch will not be executed."
}

@test "If SKIP_CHECKOUT is true git-checkout will not be called" {
Expand All @@ -430,7 +430,7 @@ cat_github_output() {

assert_success

assert_line "::debug::git-checkout has not been executed"
assert_line "::debug::git-checkout will not be executed."
}

@test "It pushes generated commit and tag to remote and actually updates the commit shas" {
Expand Down Expand Up @@ -1090,5 +1090,5 @@ cat_github_output() {
run git_auto_commit

assert_failure;
assert_line "::error ::git-auto-commit could not find git binary. Please make sure git is available."
assert_line "::error::git-auto-commit could not find git binary. Please make sure git is available."
}