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

Add workflow templates for a common pattern. #23

Closed

Conversation

adnapibar
Copy link

Description

This change adds GitHub Action workflows templates for repositories under the opensearch-project organization. The purpose is to conform to a common pattern for using GitHub Actions for CI & CD.

Issues Resolved

opensearch-project/opensearch-build#116

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Rabi Panda pandarab@amazon.com

This change adds two workflow templates for repositories under
opensearch-project. The purpose is to adhering to a common pattern
for using GitHub actions for CI & CD.

Signed-off-by: Rabi Panda <pandarab@amazon.com>
@adnapibar adnapibar marked this pull request as draft July 30, 2021 20:30
@adnapibar adnapibar marked this pull request as ready for review August 2, 2021 17:23
@dblock
Copy link
Member

dblock commented Aug 2, 2021

Let's add a GH action badge and enable dummy CI on this repo?

@dblock
Copy link
Member

dblock commented Aug 3, 2021

++ Did you enable this in your fork? Can we see some results?

@adnapibar
Copy link
Author

++ Did you enable this in your fork? Can we see some results?

I ran one on the common-utils fork based on the workflow template https://github.com/adnapibar/common-utils/runs/3234294435?check_suite_focus=true

dblock
dblock previously approved these changes Aug 6, 2021
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Nice.

Maybe the script should be called dco-signoff-check just to be super explicit? NBD

@adnapibar
Copy link
Author

@dblock Thanks! Can you please merge it.

@dblock
Copy link
Member

dblock commented Aug 6, 2021

Enable GH actions on your fork for the .github repo, and show me that these workflows work? I think you should do #25 as part of this PR to make sure the workflows are actually function. (I am pretty sure this will fail if we enable it now because those scripts called gradlew.)

Signed-off-by: Rabi Panda <adnapibar@gmail.com>
@adnapibar
Copy link
Author

Enable GH actions on your fork for the .github repo, and show me that these workflows work? I think you should do #25 as part of this PR to make sure the workflows are actually function. (I am pretty sure this will fail if we enable it now because those scripts called gradlew.)

Added the DCO check workflow for this repo. Here is how it worked in my .github fork https://github.com/adnapibar/.github/runs/3267249808?check_suite_focus=true

Yes, this is not a Gradle based Java project so for these kind of projects we can remove those steps and only keep the DCO check. For all Gradle based Java project the template can be used as is e.g. here is the workflow on the common-utils fork - https://github.com/adnapibar/common-utils/runs/3267308452?check_suite_focus=true

@dblock
Copy link
Member

dblock commented Aug 9, 2021

I am a little worried about the proliferation of things like workflow-template, these are a little hard to discover and they aren't exactly templates. Furthermore we have both OpenSearch and OpenSearch Dashboards projects in this repo. What do you think about just merging these into an actually running CI/CD workflow, and either commenting out the parts that invoke scripts or making a comment such as "for example of an OpenSearch workflow, see [link]", "for an example of an OpenSearch Dashboards workflow, see [link]"?

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.

None yet

2 participants