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.

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

PSCE-309 - Adds sync-upstreams GitHub Action and usage documentation #148

Merged
merged 4 commits into from
Jan 17, 2024

Conversation

jpower432
Copy link
Member

@jpower432 jpower432 commented Jan 12, 2024

Description

Adds sync-upstreams GitHub Action and documentation on usage.

Review Hints

The first commit adds common.sh reduce some of the duplicate logic in the entrypoint bash scripts to prepare to add a fourth script.

Stacked with #142

Rationale

  • Choice 1: Create a common.sh file - There was about ~39 lines of duplicated logic per file so before adding another file with duplicated, I add that logic to a common file that will just store reusable functions.
  • Choice 2: Make the GitHub Action argument for sources newline separated - The sources list has the potential to be really long so allowing this input to be newline separated to help readability of the workflow file for consumers.

Type of change

  • New feature (non-breaking change which adds functionality)

How has this been tested?

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

To reduce code duplication in the bash script, common logic
is added to common.sh for reuse.

Signed-off-by: Jennifer Power <[email protected]>
The working directory is subject to change and the entrypoint
scripts need to source `common.sh` from the location in the container.

Signed-off-by: Jennifer Power <[email protected]>
@@ -104,7 +105,40 @@ jobs:
branch: ${{ github.head_ref }}
```

## Component Regeneration
## Propagate Changes from upstream sources

Copy link
Contributor

@beatrizmcouto beatrizmcouto Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestions - change te word "Changes" to start with a lowercase c

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestions and uppercase T in "trestlebot"

Copy link
Contributor

@beatrizmcouto beatrizmcouto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very minor comments added, approved

@jpower432 jpower432 enabled auto-merge (squash) January 17, 2024 15:02
@jpower432 jpower432 merged commit f0ce981 into main Jan 17, 2024
9 checks passed
@jpower432 jpower432 deleted the PSCE-309 branch January 26, 2024 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants