Skip to content

ADMIN.md

Latest commit

 

History

History
73 lines (51 loc) · 2.51 KB

ADMIN.md

File metadata and controls

73 lines (51 loc) · 2.51 KB

Admin Operations

Approving New Repository Requests

Repository requests are tracked via issues in the .github repository. Only admins are authorized to approve such requests.

Steps to Approve a New Repository Request

  1. Review the Request

    • Open the issue requesting the new repository.
    • Verify that the request includes required information.

  2. Confirm Approval Criteria

    • Ensure the request follows organization guidelines and conventions as outlined in CONVENTIONS.md.
    • Check for duplicate or conflicting repository names.

    Since the repository name is often matching the app ID please check it is also unique among apps published in Splunkbase! 🚧

  3. Approve the Request

    • Add label approved to the issue.

  4. Create the Repository

    • Automation in place will create the repository and notify the requestor by providing a link to the repository in a comment.

    🔗 Repository bootstrap

Tagging Workflows

Only admins are authorized to create tags.

Steps:

  1. Ensure all workflow changes are merged into the main branch.

  2. Create a new tag on the main branch replacing the x opportunely.

    git checkout main
git pull
git tag -a 1.x.x <commit-sha> -m "1.x.x add here your message"
git push origin tag 1.x.x

  3. Confirm the tag appears in the repository.

Creating a Major Tag Pointing to the Latest Patch Tag

To create a tag 1 that points to the same commit as 1.x.x (e.g. 1.0.0):

# Identify the commit SHA that 1.x.x points to
# or copy it from the GitHub Web Interface
git rev-parse 1.x.x
# Create the 1 tag at that same commit
git tag 1 <commit-sha>
git push origin 1

By creating such a tag and updating it as soon as a latest patch or minor tag is available, consumers can:

  • reference workflows by major tag only: .github/workflows/reusable.yml@1
  • be sure it will be using the most recent workflows

Updating a Major Tag Pointing to the Latest Tag

To update tag 1 to point to a new patch tag 1.x.y (e.g. 1.0.1):

# Checkout the latest release version
git checkout 1.x.y
# Force-create the tag locally. Moves the tag 1 to your current commit
git tag -fa 1 -m "Update version 1 to point to 1.x.y"
# Force-push the tag to github
git push origin 1 --force