Start migrating CircleCI workflow to GitHub actions #3432

owais · 2021-05-19T19:27:14Z

Introduce GitHub Actions build/test/publish workflow. This ports most of the build-publish workflow from CircleCI to Github Actions. Most of the pipeline and the scripts have been taken from the core repo and adapted where necessary to work with contrib.

Pending work items (will be completed in separate PRs):

Enable publish-dev and publish-stable jobs (disbaled for now; need to setup secrets with proper protection).
Integrate github issuegenerator to report some failures such as loadtest as github issues.
Disable CircleCI.

Regressions

Duplication in Github YAML (separate work item):

Github does not support re-usable steps, running actions from within other actions or YAML anchors like CircleCI. As a result there is a lot of duplication in the file. I'll follow up this with a solution to elimination the duplication. I'm thinking to have a build-and-test.in.yaml file which will use anchors to re-use blocks (like go and tooling cache, publish stable+dev, etc) and then have a tool that generates another build-and-test.yaml from that file with expanded anchors. This is a separate work item though so not included in this PR.

Can't re-run only failed jobs

This can be extremely annoying. If a single job fails in a workflow, there is no way to retry just the failed job. Only way to retry is to retry the entire workflow. This has been very annoying for personally with other Otel and Splunk projects. GitHub has acknowledged that the feature is on their roadmap but there is no ETA on this. We can hack together a solution that stores the result (pass/fail) of every job in workflow somewhere and on re-runs skips jobs if:

they passed in the previous run of the same workflow
no files affecting the job had any changes

This is very much possible to implement but not sure if it is worth it. Either way we can invest time into it IF it turns out to be a big issue.

Pipelines

CircleCI

Github Actions

GitHub workflow lists all jobs even if they're not supposed to run in that workflow such as publish-dev/publish-stable in ^ screenhot.

mx-psi · 2021-05-21T10:44:18Z

One item that IMO we should add to the pending work items list is to enable Dependabot for Github Actions. Maybe we should have a separate issue to track this?

owais · 2021-05-21T11:51:06Z

Yes, that doesn't seem related to CI jobs. Separate issue would be better IMO.

tigrannajaryan · 2021-05-21T13:57:11Z

I'm thinking to have a build-and-test.in.yaml file which will use anchors to re-use blocks (like go and tooling cache, publish stable+dev, etc) and then have a tool that generates another build-and-test.yaml from that file with expanded anchors. This is a separate work item though so not included in this PR.

SGTM.

Can't re-run only failed jobs

A good reason for us to focus on making our tests rock stable (the tests are the offenders which require rerunning). Let's spend the time we would spend on finding a solution to rerun single jobs on making our tests stable. It is a better investment IMO.

tigrannajaryan

The approach LGTM, thanks for working on this.

owais · 2021-05-21T15:40:45Z

A good reason for us to focus on making our tests rock stable (the tests are the offenders which require rerunning). Let's spend the time we would spend on finding a solution to rerun single jobs on making our tests stable. It is a better investment IMO.

Definitely but despite that this can be an annoyance for people working on new features and using CI for tests. Luckily I think collector's local workflow is simple enough to run and verify everything locally so CI shouldn't be required to be part of the local iteration process.

tigrannajaryan · 2021-05-27T14:01:55Z

@owais can you please rebase, the failed loadtest should pass now.

tigrannajaryan · 2021-05-27T14:07:40Z

.github/workflows/build-and-test.yml

+  publish-stable:
+    runs-on: ubuntu-latest
+    needs: [lint, unittest, integration-tests, build-package, windows-msi]
+    if: ${{ false }}


Can you add a comment to explain why this is excluded?

tigrannajaryan · 2021-05-27T14:08:06Z

.github/workflows/build-and-test.yml

+    runs-on: ubuntu-latest
+    needs: [lint, unittest, integration-tests, build-package, windows-msi]
+    if: ${{ false }}
+    # if: startsWith(github.ref, 'refs/tags/') && github.repository == 'open-telemetry/opentelemetry-collector-contrib'


Do we need this? Can we delete commented code or turn it into a TODO comment?

tigrannajaryan · 2021-05-31T15:20:10Z

.github/workflows/build-and-test.yml

+    runs-on: ubuntu-latest
+    needs: [lint, unittest, integration-tests, build-package, windows-msi]
+    if: ${{ false }}
+    # if: (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')) && github.repository == 'open-telemetry/opentelemetry-collector-contrib'


Same here: Can we delete commented code or turn it into a TODO comment?

tigrannajaryan

LGTM, just one comment left, will merge after that is addressed.

owais · 2021-05-31T16:19:49Z

Looks like loadtests are unreliable on GH actions compared to Circle. Nothing blocks this PR but we might want to keep loadtests on Circle for a while. In the long run, we probably need funding to be able to run loadtests in the cloud where we can predict performance a bit more reliably.

gramidt

There appears to be a new empty file 'otelcontribcol-all-sys' as part of this PR. Was this intentional?

owais · 2021-06-01T22:26:32Z

@gramidt No, removed. Thanks

tigrannajaryan · 2021-06-02T14:11:29Z

@bogdandrutu this looks good to me. We can merge if you don't have any additional thoughts.

bogdandrutu

This looks good to me as a high-level direction, did not look at the code but trust @tigrannajaryan

bogdandrutu · 2021-06-02T14:21:36Z

internal/buildscripts/packaging/msi/make.ps1

@@ -73,3 +77,4 @@ function Confirm-MSI {

 $sb = [scriptblock]::create("$Target")
 Invoke-Command -ScriptBlock $sb
+exit 0


This ports most of the build-publish workflow from CircleCI to Github Actions. Pending work items: - Enable publish-dev and publish-stable jobs (disbaled for now; need to setup secrets with proper protection). - Integrate github issuegenerator to report some failures such as loadtest as github issues. - Disable CircleCI.

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>

owais changed the title ~~Move jobs to GitHub actions~~ Start migrating CircleCI workflow to GitHub actions May 21, 2021

owais marked this pull request as ready for review May 21, 2021 08:26

owais requested a review from a team May 21, 2021 08:26

github-actions bot assigned tigrannajaryan May 21, 2021

owais requested review from tigrannajaryan, bogdandrutu and dmitryax May 21, 2021 08:26

owais marked this pull request as draft May 21, 2021 09:48

mx-psi mentioned this pull request May 21, 2021

Enable Dependabot for Github Actions #3445

Closed

tigrannajaryan reviewed May 21, 2021

View reviewed changes

owais marked this pull request as ready for review May 21, 2021 15:38

github-actions bot assigned djaglowski May 21, 2021

andresbeckruiz mentioned this pull request May 25, 2021

Bug report for failed CircleCI build (job: loadtest) #3131

Closed

tigrannajaryan reviewed May 27, 2021

View reviewed changes

tigrannajaryan reviewed May 31, 2021

View reviewed changes

owais requested a review from tigrannajaryan May 31, 2021 16:17

gramidt suggested changes Jun 1, 2021

View reviewed changes

tigrannajaryan approved these changes Jun 2, 2021

View reviewed changes

gramidt approved these changes Jun 2, 2021

View reviewed changes

bogdandrutu approved these changes Jun 2, 2021

View reviewed changes

bogdandrutu merged commit 2378271 into open-telemetry:main Jun 8, 2021

owais deleted the move-jobs-to-github-actions branch June 8, 2021 11:06

alexperez52 referenced this pull request in open-o11y/opentelemetry-collector-contrib Aug 18, 2021

Remove unnecessary public structs from testbed (#3432)

531fd92

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Start migrating CircleCI workflow to GitHub actions #3432

Start migrating CircleCI workflow to GitHub actions #3432

owais commented May 19, 2021 •

edited

Loading

mx-psi commented May 21, 2021

owais commented May 21, 2021

tigrannajaryan commented May 21, 2021

Can't re-run only failed jobs

tigrannajaryan left a comment

owais commented May 21, 2021

tigrannajaryan commented May 27, 2021

tigrannajaryan May 27, 2021

tigrannajaryan May 27, 2021

tigrannajaryan May 31, 2021

owais May 31, 2021

tigrannajaryan left a comment

owais commented May 31, 2021

gramidt left a comment

owais commented Jun 1, 2021

tigrannajaryan commented Jun 2, 2021

bogdandrutu left a comment

bogdandrutu Jun 2, 2021

Start migrating CircleCI workflow to GitHub actions #3432

Start migrating CircleCI workflow to GitHub actions #3432

Conversation

owais commented May 19, 2021 • edited Loading

Pending work items (will be completed in separate PRs):

Regressions

Duplication in Github YAML (separate work item):

Can't re-run only failed jobs

Pipelines

CircleCI

Github Actions

mx-psi commented May 21, 2021

owais commented May 21, 2021

tigrannajaryan commented May 21, 2021

Can't re-run only failed jobs

tigrannajaryan left a comment

Choose a reason for hiding this comment

owais commented May 21, 2021

tigrannajaryan commented May 27, 2021

tigrannajaryan May 27, 2021

Choose a reason for hiding this comment

tigrannajaryan May 27, 2021

Choose a reason for hiding this comment

tigrannajaryan May 31, 2021

Choose a reason for hiding this comment

owais May 31, 2021

Choose a reason for hiding this comment

tigrannajaryan left a comment

Choose a reason for hiding this comment

owais commented May 31, 2021

gramidt left a comment

Choose a reason for hiding this comment

owais commented Jun 1, 2021

tigrannajaryan commented Jun 2, 2021

bogdandrutu left a comment

Choose a reason for hiding this comment

bogdandrutu Jun 2, 2021

Choose a reason for hiding this comment

owais commented May 19, 2021 •

edited

Loading