GitHub Action Submodule Updates
ActionsTags
(1)This GitHub action creates a new branch and pull request against the parent repository when submodules are updated
The end goal of this tool:
- Create a new branch on the parent repository and get all submodules updates
- Create a pull request from newly created branch
- Add a custom label to the pull request
To use this GitHub Action you will need to complete the following in the submodule repository:
- Parent repository has
.gitmodulesconfigured - Store GitHub token into secrets with permissions to write to parent repository
- Create a new file in your repository called
.github/workflows/submodule-update.yml - Copy the example workflow from below into that new file and modify as needed
- Commit that file to a new branch
- Observe the action working
This file should have the following code:
---
name: Submodule Updates
#############################
# Start the job on all push #
#############################
on:
push:
branches-ignore: [master, main]
pull_request:
branches: [master, main]
###############
# Set the Job #
###############
jobs:
build:
name: Submodule update
runs-on: ubuntu-latest
env:
PARENT_REPOSITORY: 'org/example-repository'
CHECKOUT_BRANCH: 'main'
PR_AGAINST_BRANCH: 'main'
OWNER: 'org'
steps:
##########################
# Checkout the code base #
##########################
- name: Checkout Code
uses: actions/checkout@v2
####################################
# Run the action against code base #
####################################
- name: run action
id: run_action
uses: releasehub-com/github-action-create-pr-parent-submodule@v1
with:
github_token: ${{ secrets.RELEASE_HUB_SECRET }}
parent_repository: ${{ env.PARENT_REPOSITORY }}
checkout_branch: ${{ env.CHECKOUT_BRANCH}}
pr_against_branch: ${{ env.PR_AGAINST_BRANCH }}
owner: ${{ env.OWNER }}
GitHub Action Submodule Updates is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
v1
LatestTags
(1)GitHub Action Submodule Updates is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.