Merge pull request #1 from GlueOps/feature/generate-default-glueops-tags

feat: generate tags action

Author: fernandoataoldotcom

README.md

@@ -1 +1,28 @@
-# github-actions-create-container-tags
+# Custom Action to Create the Default GlueOps Image Tags
+
+The GlueOps platform relies upon specific tags for CI/CD automation. This Action automates the creation of those tags.
+
+## Tags Created
+
+* `Target Reference:` Either Branch Name or Tag, depending upon the trigger context.
+* `Short SHA`
+* `SHA`
+
+## Usage
+
+Can be implemented as a stand alone action, or coupled with the action [GlueOps/github-actions-build-push-containers](https://github.com/GlueOps/github-actions-build-push-containers).
+
+### Output Values
+
+* `tags_csv`: comma-separated string of generated tags.
+* `clean_target_ref`: the target reference (e.g. branch name or tag) with invalid characters for a container tag removed.
+* `target_ref_type`: the type of target reference, one of ["branch", "pull_request", "tag", "unknown"].
+
+### Example Configuration
+
+```yaml
+- name: Create GlueOps Tags
+    if: inputs.tags == ''
+    uses: Glueops/[email protected]
+    id: create-tags
+```

action.yml

@@ -0,0 +1,62 @@
+name: 'Create GlueOps Image Tags'
+description: 'Creates tags for docker images used by the GlueOps platform'
+
+outputs:
+  tags_csv:
+    description: 'Comma-separated list of GlueOps image tags'
+    value: ${{ steps.create-tags.outputs.tags }}
+  clean_target_ref:
+    description: 'Target reference with invalid tag characters removed'
+    value: ${{ steps.create-tags.outputs.target-ref}}
+  target_ref_type:
+    description: 'Type of Target ref, as ["branch", "pull_request", "tag", "unknown"]'
+    value: ${{ steps.create-tags.outputs.target-ref-type }}
+
+runs:
+  using: "composite"
+  steps:
+    - name: Create Tags
+      id: create-tags
+      shell: bash
+      run: |
+        echo "::group::determine ref"
+        if [[ $GITHUB_REF == refs/heads/* ]]; then
+          REF_TYPE=branch
+          TARGET_REF=${GITHUB_REF#refs/heads/}
+        elif [[ $GITHUB_REF == refs/tags/* ]]; then
+          REF_TYPE=tag
+          TARGET_REF=${GITHUB_REF#refs/tags/}
+        elif [[ $GITHUB_REF == refs/pull/* ]]; then
+          REF_TYPE=pull_request
+          TARGET_REF=$GITHUB_SHA
+        else
+          REF_TYPE=unknown
+        fi
+        echo "target-ref-type=$TARGET_REF" >> $GITHUB_OUTPUT
+
+        echo "::endgroup::"
+        # Create default tags
+        SHA="${{ github.sha }}"
+        SHORT_SHA="${SHA:0:7}"
+
+        # Remove invalid tag characters from TARGET_REF
+        TARGET_REF="${TARGET_REF#refs/tags/}" 
+        TARGET_REF="${TARGET_REF#refs/heads/}"
+        TARGET_REF=${TARGET_REF////-}      # Replace slashes with hyphens
+        TARGET_REF=${TARGET_REF//[^a-zA-Z0-9_.-]/_}   # Replace invalid characters with underscores
+        TARGET_REF=${TARGET_REF// /_}      # Replace whitespaces with underscores
+        TARGET_REF=${TARGET_REF,,}         # Convert to lowercase
+        echo "target-ref=$TARGET_REF" >> $GITHUB_OUTPUT
+
+
+        # Array of tags to generate
+        TAGS_ARRAY=(
+          "${TARGET_REF}"
+          "${SHORT_SHA}"
+          "${SHA}"
+        )
+        
+        IFS=','
+        TAGS=${TAGS_ARRAY[*]}
+        echo "Computed tags: $TAGS"
+        echo "tags=$TAGS" >> $GITHUB_OUTPUT