ISISComputingGroup / ISISComputingGroup/IBEX

Jenkins or GitHub Workflow: Update Submodules

Open
#7,348 2 comments 0 reactions 0 assignees View on GitHub
Friday no_release_notes
Dominant language
No language data
Stars
6
Forks
2
Avg merge
16h 40m
Merged PRs (30d)
2

Description

As a: developer, I would like to adapt an existing, but unused GitHub workflow to work through Jenkins to automatically update submodules on push.

The existing workflow relies on a personal access token as described in the readme of the [repository](https://github.com/ISISComputingGroup/Update_Submodule_Workflow_Action) and the [wiki page](https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/Shared-utility-scripts#github-workflows) which will need to be altered for use with submodules of the [EPICS parent repository](https://github.com/ISISComputingGroup/EPICS). - A personal access token should be avoided if tied to a specific user and not a GitHub organisation account.

If you need a hand understanding the workflow, feel free to contact [Jack Allen](https://github.com/JackEAllen)

### Acceptance Criteria
_What is the acceptance criteria?_
- [ ] A Jenkins workflow exists to replicate the [GitHub workflow](https://github.com/ISISComputingGroup/Update_Submodule_Workflow_Action)
- [ ] The Wiki is updated appropriately to describe new workflow [HERE](https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/Shared-utility-scripts#github-workflows)

### Extra Information
_Why it is needed?_
- To remove the need for a check to take place asking a developer to perform this task manually.
- To optimise developer workflow.

_Where required files/links are_
- GitHub Workflow to use as base to work from: [Update Submodule GitHub Template Repository](https://github.com/ISISComputingGroup/Update_Submodule_Workflow_Action)
- Wiki Page describing workflow: [Workflows](https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/Shared-utility-scripts)

## How to Test
_verbose instructions for reviewer to test changes
(**Add before making a PR**)_
1. Create a test parent repository and child repository and connect to workflow.
2. Make a change to the child repo see if change updated in parent repo on push to master / main branch.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.