Migrate from Travis to GitHub Actions

[thomasplevy]

Alright... we're close enough to everything working that I'm ready to enlist y'all to help get us switched from Travis to GH actions and over to using update WP core utilities for phpunit testing.

Go through your plugins and update/add a codeowners file while you're at it

Updates to be made:

• Remove composer.lock file

• Remove the composer scripts install-php8 & tests-install-php8

• Change the required version of lifterlms-tests to be ^3.1.0

• Add composer.lock to the .gitignore file

• Add results caching file location in the tmp dir by adding cacheResultFile="tmp/.phpunit.result.cache" to the phpunit.xml.dist file

• Run tests, fix anything that fails

  • setUp(), tearDown(), setUpBeforeClass() and tearDownAfterClass() should be replaced with snake-case equivalents: set_up(), tear_down(), etc...
  • assertEqualsWithDelta() in favor of assertEquals() with the delta passed as the 4th param. If we miss these well catch them when tests intermittently fail later, this is less problematic (and obvious)

• Check .travis.yml for "extra" jobs (other than the standard matrix

  • Add a .github/workflow-matrix.yml IF the repo has a non-standard job (see docs and talk to me if you're not sure)
  • If there's an ESLint job, update the workflow-sync file to include the repo, see ESLint #22 (comment) comment here with the name of your repo: ESLint #22
  • If there's an e2e job, comment here with the name of the repo: E2E testing #23

• Remove .travis.yml

• Add .github/CODEOWNERS

• Remove .github/ISSUE_TEMPLATE/ and .github/PULL_REQUEST_TEMPLATE.md (these are automatically used from this repo if none are found in the repo's .github dir, so they're redundant and can be removed)

• Remove travis badges from the README.md file and add PHPCS, coding standards, and test coverage badges from the GH workflows

• Create the CC_TEST_REPORTER_ID repository secret

• Commit and push everything (trunk & dev)

• Make sure everything runs / passes / etc...

• Talk to me about problems

• https://github.com/gocodebox/lifterlms

• https://github.com/gocodebox/lifterlms-advanced-quizzes

• https://github.com/gocodebox/lifterlms-advanced-videos

• https://github.com/gocodebox/lifterlms-assignments

• https://github.com/gocodebox/lifterlms-blocks

• https://github.com/gocodebox/lifterlms-convertkit

• https://github.com/gocodebox/lifterlms-cli

• https://github.com/gocodebox/lifterlms-custom-fields

• https://github.com/gocodebox/lifterlms-gateway-authorize-net

• https://github.com/gocodebox/lifterlms-gateway-paypal

• https://github.com/gocodebox/lifterlms-groups

• https://github.com/gocodebox/lifterlms-helper

• https://github.com/gocodebox/lifterlms-integration-formidable-forms

• https://github.com/gocodebox/lifterlms-integration-gravity-forms

• https://github.com/gocodebox/lifterlms-integration-ninja-forms

• https://github.com/gocodebox/lifterlms-integration-twilio

• https://github.com/gocodebox/lifterlms-integration-woocommerce

• https://github.com/gocodebox/lifterlms-integration-wpforms

• https://github.com/gocodebox/lifterlms-labs

• https://github.com/gocodebox/lifterlms-lite-lms-progress-tracker

• https://github.com/gocodebox/lifterlms-mailchimp

• https://github.com/gocodebox/lifterlms-pdfs

• https://github.com/gocodebox/lifterlms-private-areas

• https://github.com/gocodebox/lifterlms-rest

• https://github.com/gocodebox/lifterlms-social-learning

• https://github.com/gocodebox/lifterlms-stripe

[thomasplevy]

How to create a status badge for a GH Action Workflow:

Peek.2021-10-04.09-50.mp4

[pondermatic]

Create the CC_TEST_REPORTER_ID repository secret

What should the value be?

@thomasplevy, I do not see the "Settings" menu item for any of the gocodebox projects.

From GitHub Encrypted secrets page:

To create secrets for a user account repository, you must be the repository owner. To create secrets for an organization repository, you must have admin access.

[thomasplevy]

@pondermatic I'll add them. i didn't realize secrets were only available to repo owner .

[pondermatic]

Should the .github directory also be in the dev branch, or just the trunk branch? The mail chimp plugin doesn't have it in the dev branch and it looks like Workflow Sync Bot added it to trunk .

[thomasplevy]

In almost all scenarios we want to move dev -> trunk but the workflow bot goes straight to trunk because it deploys not distributed files (workflows). One day I'll make a workflow to sync trunk to dev when we push changes directly there: #19

For this particular project it's "safe" to push right to trunk and once the changes are ready sync those over to dev manually

[thomasplevy]

(or do dev first and then sync to trunk if you're more comfortable with that)

[thomasplevy]

@gocodebox/engineering CC_TEST_REPORTER_ID secret added to all the repos in question and I've updated the test coverage job to be skipped if the secret isn't present (as is the case when running checks on a PR from a fork)

[pondermatic]

I tried to push commits to the trunk branch of gocode/lifterlms-assignments and got error: GH006: Protected branch update failed for refs/heads/trunk..

[thomasplevy]

The branch requires signed commits, are your commits not signed?

[pondermatic]

The branch requires signed commits, are your commits not signed?

I set up a GPG key with GitHub and all my recent commits have a "Verified" button in GitHub. "This commit was signed with the committer’s verified signature."

However, when I use the git log --show-signature command, my commits do not show GPG info and yours and Rocco's do. Looks like there's more to configure.

BTW, do we have a place to store our public keys? 1Password maybe?

[pondermatic]

My commits to my local trunk branch of gocode/lifterlms-assignments are signed with a key that is registered with GitHub. However, I get this when I push to origin.

remote: error: GH006: Protected branch update failed for refs/heads/trunk.
remote: error: 4 of 4 required status checks are expected.
To https://github.com/gocodebox/lifterlms-assignments.git
! [remote rejected] trunk -> trunk (protected branch hook declined)
error: failed to push some refs to 'https://github.com/gocodebox/lifterlms-assignments.git'

[pondermatic]

I am able to push signed (and unsigned) commits to the trunk branch of gocodebox/lifterlms-mailchimp.

When I setup signing keys a few weeks ago, I didn't update my global git config to automatically GPG sign all my commits. Even though GitHub shows commits during the past few weeks as "verified", they were not GPG signed. They will be going forward.

[eri-trabiccolo]

@gocodebox/engineering
https://github.com/gocodebox/lifterlms-integration-formidable-forms doesn't have any unit tests at all, no composer scripts no nothing. I just added the CODEOWNERS file and gitignored composer.lock (which btw, doesn't exist).

[pondermatic]

Once we get GitHub workflows to run successfully, should we delete the failed runs?

[eri-trabiccolo]

Once we get GitHub workflows to run successfully, should we delete the failed runs?

I was for the "I don't care" mode on :P eheh

[pondermatic]

For this particular project it's "safe" to push right to trunk and once the changes are ready sync those over to dev manually

In gocodebox/lifterlms-pdfs, I pushed commits to trunk and then cherry picked those commits to dev. The commits have different hashes between trunk and dev. I assumed they would be the same. GitHub suggests that I merge dev to trunk and confusingly the compare looks like the commits to trunk aren't there.

Please help me @gocodebox/engineering. You are my only hope.

[eri-trabiccolo]

@pondermatic
fast way, to me:

1. delete local dev, pull remote dev
2. rebase local dev on the new trunk
3. force push to remote dev
4. push local dev to remote trunk

[pondermatic]

Thank you @eri-trabiccolo! Your suggested procedure worked perfectly.

[eri-trabiccolo]

My commits to my local trunk branch of gocode/lifterlms-assignments are signed with a key that is registered with GitHub. However, I get this when I push to origin.

remote: error: GH006: Protected branch update failed for refs/heads/trunk.
remote: error: 4 of 4 required status checks are expected.
To https://github.com/gocodebox/lifterlms-assignments.git
! [remote rejected] trunk -> trunk (protected branch hook declined)
error: failed to push some refs to 'https://github.com/gocodebox/lifterlms-assignments.git'

I have a similar issue with the lifterlms-rest:dev branch.
Since the dev branch is some commits ahead of trunk, I rebased it and wanted then to force push it.
Result:

remote: Resolving deltas: 100% (20/20), completed with 8 local objects.
remote: error: GH006: Protected branch update failed for refs/heads/dev.
remote: error: Cannot force-push to this protected branch
To https://github.com/gocodebox/lifterlms-rest
 ! [remote rejected] dev -> dev (protected branch hook declined)
error: failed to push some refs to 'https://github.com/gocodebox/lifterlms-assignments.git'

Note that I did something similar on lifterlms-integration-wpforms:dev and it went through. Also my commits are all verified...

[eri-trabiccolo]

@pondermatic
do we want to work on the remaining repositories owned by Thomas?
If so please tell me on which you're going to work so to avoid overlaps :D

[pondermatic]

@thomasplevy
It seems that the lifterlms-integration-twilio project needs some secret environment variables set in order to run unit tests.

LLMS_TWILIO_SID
LLMS_TWILIO_AUTHKEY

Also, when I tried to log into Twilio to get our authentication to run tests locally, I got this page:

I do not have access to the [email protected] mailbox.

I was able to use my own Twilio account to run the tests successfully.

[thomasplevy]

Once we get GitHub workflows to run successfully, should we delete the failed runs?

@pondermatic Nope, don't bother, who cares!

[thomasplevy]

BTW, do we have a place to store our public keys? 1Password maybe?

You can store your keys in 1pass if you want but, in general I haven't found a need to have a centralized store for our dev public keys... I guess it makes sense to do so but I haven't needed them for anything so...

[thomasplevy]

I do not have access to the [email protected] mailbox.

Yes you do, it's the support inbox in HelpScout (recently renamed to "Conversation Team"

[thomasplevy]

It seems that the lifterlms-integration-twilio project needs some secret environment variables set in order to run unit tests.

Added

[pondermatic]

BTW, do we have a place to store our public keys? 1Password maybe?

You can store your keys in 1pass if you want but, in general I haven't found a need to have a centralized store for our dev public keys... I guess it makes sense to do so but I haven't needed them for anything so...

I added mine to 1pass today. If the developers had each other's public keys, then the git log --show-signature command would be "prettier". That's about the only benefit I know of. Unless we start encrypting emails to each other. Nah, you'd never read them.

[pondermatic]

It seems that the lifterlms-integration-twilio project needs some secret environment variables set in order to run unit tests.

Added

The LLMS_Twilio_Test_API::test_call_error_400 PHPUnit test fails with error code 20003, permission denied.

LLMS_Twilio_Test_API::test_call_success errors out, but the error is not echoed to the console.

Should I create an issue for these, or is this something you've seen before the change from TravisCI to GitHub actions?

[thomasplevy]

The LLMS_Twilio_Test_API::test_call_error_400 PHPUnit test fails with error code 20003, permission denied.

LLMS_Twilio_Test_API::test_call_success errors out, but the error is not echoed to the console.

Should I create an issue for these, or is this something you've seen before the change from TravisCI to GitHub actions?

Please create an issue (in Twilio repo) to track this, I haven't seen this particular error before and I'll need to investigate this further to determine what's happening.

[eri-trabiccolo]

@thomasplevy
Trying to summarize below:

• https://github.com/gocodebox/lifterlms-assignments - @pondermatic worked on it but cannot push on the remote branch see: Migrate from Travis to GitHub Actions #21 (comment)
• https://github.com/gocodebox/lifterlms-cli - I'm not sure how to turn its .travis.yml to github actions. Also this repo has no PHP unit tests so I guess the whole PHP Unit and tests coverage should be skipped, right?
• https://github.com/gocodebox/lifterlms-labs - This repo has no PHP unit tests so I guess the whole PHP Unit and tests coverage should be skipped, right?
• https://github.com/gocodebox/lifterlms-lite-lms-progress-tracker - as above
• https://github.com/gocodebox/lifterlms-integration-formidable-forms - This repo has no PHP unit tests, nor it has cs rules. Just added CODEOWNERS and ignored composer.lock.
• https://github.com/gocodebox/lifterlms-gateway-authorize-net - missing credentials? See
  https://github.com/gocodebox/lifterlms-gateway-authorize-net/issues/14 and https://github.com/gocodebox/lifterlms-gateway-authorize-net/issues/15
• https://github.com/gocodebox/lifterlms-gateway-paypal - The trunk doesn't have php tests, but the branch 2.0 on which you're working on does have them, I thought you wanted to do the migration directly on 2.0? Dunno.
• https://github.com/gocodebox/lifterlms-integration-twilio - @pondermatic is on it - tests failing, see https://github.com/gocodebox/lifterlms-integration-twilio/issues/28 and https://github.com/gocodebox/lifterlms-integration-twilio/issues/29
• https://github.com/gocodebox/lifterlms-social-learning - There are no tests in trunk, but the new ones in dev pass.
• https://github.com/gocodebox/lifterlms-rest - Migration done on trunk, couldn't push on dev after a rebase, see Migrate from Travis to GitHub Actions #21 (comment)

[thomasplevy]

@eri-trabiccolo force push has been enabled for the dev branch on the lifterlms-rest

[thomasplevy]

My commits to my local trunk branch of gocode/lifterlms-assignments are signed with a key that is registered with GitHub. However, I get this when I push to origin.

remote: error: GH006: Protected branch update failed for refs/heads/trunk.
remote: error: 4 of 4 required status checks are expected.
To https://github.com/gocodebox/lifterlms-assignments.git
! [remote rejected] trunk -> trunk (protected branch hook declined)
error: failed to push some refs to 'https://github.com/gocodebox/lifterlms-assignments.git'

@pondermatic I've turned force-push on for the trunk branch but I'd like to turn it back on after you're done. Let me know when you're happy here and I'll reenable.