docs: CI/CD update - branches / contract_requiring_verification_published webhook #149

YOU54F · 2022-10-04T12:40:47Z

Update Pactflow CI/CD Workshop

update to use contract_requiring_verification_published event/webhook
update to use branches over tags
rename workshop to Consumer-Driven Contract Testing (to contrast against Bi-Directional Contract Testing) workshops
some other niceties (file locations, git commit commands)

…ep info note

bethesque · 2022-10-04T21:53:58Z

website/docs/docs/workshops/ci-cd.md

@@ -1,6 +1,6 @@
 ---
 id: ci-cd
-title: Pactflow CI/CD Workshop
+title: Consumer-Driven Contract Testing Workshop


Good call to clarify this now we have two different workflows. Can we make it "Consumer-Driven Contract Testing CI/CD Workshop"? Or "Consumer-Driven Contract Testing Workflow Workshop" (that one is a bit of a W mouth-full though). The point of this one is to show users how CDC fits into the pipeline, not just how to do consumer driven contract testing.

gone for

Consumer-Driven Contract Testing CI/CD Workshop

Consumer-Driven Contract Testing CI/CD Workshop (Legacy)

website/docs/docs/workshops/ci-cd/set-up-ci/04_configure_webhook.md

bethesque · 2022-10-04T23:05:16Z

Hoorah for this update happening!

…onments

website/docs/docs/workshops/ci-cd-legacy/set-up-ci/04_configure_webhook.md

YOU54F · 2022-10-07T20:13:34Z

Hey @Ilia

I've addressed these

[Minor] Setup deployment environment - "Settings > Environments", its more a UX issue, but there was no "settings", there was a gear icon, maybe worth including that as an imagine in the docs
[Minor] Setup deployment environment - "production" environment, since I had a brand new setup, I already had a production environment, and thought for some reason it will allow me to create another, but it didnt and showed an error, at this stage I wasnt sure if I could re-use the one there, OR i should delete and create another
[Minor] Configure consumer pipeline - we could instruct the user to just update the files in Github Editor and commit, potentially saving the step of cloning locally and running npm (unsure though if this is required in the next steps)
[Minor] Configure consumer pipeline - step 2, once github picked up the commit, my build errored, i thought I did something wrong, but it actually should still error. I know the text indicates that it should, but maybe a warning box may be good, as this This build should now successfully publish the pact, but it will fail on the can-i-deploy step before it tries to deploy gets lost

Not done this one yet, but it's not a bad shout, having it as a secret means the user can just add it during the pb token step 👍🏾

[Minor] Configure provider pipeline - There are TWO workflow files - we could simplify this with a shared env across workflows, there is some docs here https://arinco.com.au/blog/github-actions-share-environment-variables-across-workflows/ or maybe even have it as a secret, which is shared across all workflows - more a recommendation

bethesque · 2022-10-18T22:10:54Z

There are TWO workflow files - we could simplify this with a shared env across workflows,

Sometimes duplicated+simple is better than shared+moreComplicated ;)

bethesque · 2022-10-18T22:12:47Z

website/docs/docs/workshops/ci-cd/set-up-ci/04_configure_webhook.md

+* the latest version from the provider's main branch
+* any version currently deployed to an environment
+
+This is achieved by passing the URL of the changed pact to the build via a parameter in the body of the webhook request, as well as the provider version number and the provider branch of the head, test and production versions.


head -> main

bethesque · 2022-10-18T22:13:32Z

website/docs/docs/workshops/ci-cd/set-up-ci/04_configure_webhook.md

            * Consumer: leave as "ALL"
            * Provider: select `pactflow-example-provider`
-            * Events: select `Contract published with changed content or tags`
+            * Events: select `Contract published that requires verification`


bethesque · 2022-10-18T22:15:00Z

website/docs/docs/workshops/ci-cd/set-up-local-development/02_run_the_applications.md

-Before starting the consumer, create a `.env` file in the root of the project and add:
+Before starting the consumer, we need to configure it so it knows the address of our running provider.
+
+create a `.env` file in the root of the project and add:


bethesque · 2022-10-18T22:23:04Z

website/docs/docs/workshops/ci-cd/workshop/06_verifying_feature_pacts.md


-A "work in progress" pact is a pact that is the latest for its tag that does not have any successful verification results (ie. is still pending) for the configured provider tag . At this stage in the exercise, the `feat/new-field` pact is still in pending state for the `master` branch of the provider, so it is considered a "work in progress" pact for master.
+A "work in progress" pact is a pact that is the latest for its branch that does not have any successful verification results (ie. is still pending) for the configured provider branch . At this stage in the exercise, the `feat/new-field` pact is still in pending state for the main branch of the provider, so it is considered a "work in progress" pact for `master`.


It's slightly more complicated than this now. My brain is not working so I'll come back to this.

Now I think about it, it's not worth confusing people with the full technical details of how WIP pacts are selected at this stage. What you've got is 👍🏽

bethesque · 2022-10-18T22:24:12Z

This makes me so happy!!!! 🎉

…onments

netlify · 2022-10-21T11:41:42Z

✅ Deploy Preview for docs-pactflow-preview ready!

Name	Link
🔨 Latest commit	`f150f67`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-pactflow-preview/deploys/635285f3b7723600082282e9
😎 Deploy Preview	https://deploy-preview-149--docs-pactflow-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

YOU54F · 2022-10-21T11:53:47Z

Will merge it and go through with the SE team next week for some user feedback :)

YOU54F added 14 commits September 29, 2022 22:53

docs: ci/cd workshop - setup ci - use new webhook

db2dae6

docs: ci/cd workshop - setup local dev - consumer version selectors

49d902c

docs: ci/cd fork/clone

f27e244

docs: ci/cd prereq concepts - deprecate tags

17e486a

docs: ci/cd prereq concepts - add branch pre-req concept

065cc30

docs: ci/cd prereq concepts - add blog post link to branches in tag d…

51a10c9

…ep info note

docs: ci/cd prereq concepts - finalise

1695f01

docs: ci/cd - how-to-break - consumer drift note

8483935

docs: ci/cd - how-to-break - branch update

ce5a430

docs: ci/cd - pending-pacts - branch over tag

7513f6b

docs: ci/cd - how-not-to-break - commit instructions

66b9b38

docs: ci/cd - webhook triggers feat init pact verification build

bbc4e79

docs: ci/cd - rename to consumer-driven contract testing workshop

9a71f7a

docs: ci/cd - WIP pacts and branches over tags in cvs

5fdb7a6

YOU54F changed the title ~~docs: CI/CD update to use contract_requiring_verification_published event~~ docs: CI/CD update - branches / contract_requiring_verification_published webhook Oct 4, 2022

bethesque reviewed Oct 4, 2022

View reviewed changes

YOU54F added 7 commits October 5, 2022 17:23

Merge remote-tracking branch 'origin/master' into cicd_branches_envir…

cb19567

…onments

docs: ci/cd - workshop - rm all tag refs, central info page

a627a63

docs: ci/cd - workshop - add legacy workshop

3d465b5

docs: ci/cd - add legacy workshop repo links

f9063fa

docs: ci/cd - workshop - tags in legacy workshop

b08ad96

chore: formatting

81bf28a

chore: link correction

1448d40

Ilia reviewed Oct 7, 2022

View reviewed changes

website/docs/docs/workshops/ci-cd-legacy/set-up-ci/04_configure_webhook.md Outdated Show resolved Hide resolved

YOU54F added 2 commits October 7, 2022 20:37

chore: typo

9421d8b

chore: usability tweaks on review from Ilia

b619610

chore: add some refs to branches, remove some refs to tags

b9de703

YOU54F mentioned this pull request Oct 10, 2022

Update for branches and environments? PauloGoncalvesBH/contract-test-nirvana#3

Open

YOU54F added 2 commits October 11, 2022 18:52

docs: ci/cd workshop - enable pending by default

fcec918

docs: ci/cd - WIP pacts by default

42be12b

bethesque approved these changes Oct 18, 2022

View reviewed changes

YOU54F added 2 commits October 21, 2022 12:33

Merge remote-tracking branch 'origin/master' into cicd_branches_envir…

4e06fb6

…onments

chore: clarify tag usage in legacy workshop

a7233a5

chore: clarify tag usage in legacy workshop

f150f67

YOU54F merged commit 0b2a399 into master Oct 21, 2022

YOU54F mentioned this pull request Oct 21, 2022

Update CI/CD workshop #38

Closed

YOU54F deleted the cicd_branches_environments branch January 24, 2023 18:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: CI/CD update - branches / contract_requiring_verification_published webhook #149

docs: CI/CD update - branches / contract_requiring_verification_published webhook #149

YOU54F commented Oct 4, 2022 •

edited

Loading

bethesque Oct 4, 2022

YOU54F Oct 7, 2022

bethesque commented Oct 4, 2022

YOU54F commented Oct 7, 2022

bethesque commented Oct 18, 2022

bethesque Oct 18, 2022

bethesque Oct 18, 2022

bethesque Oct 18, 2022

bethesque Oct 18, 2022

bethesque Oct 20, 2022

bethesque commented Oct 18, 2022

netlify bot commented Oct 21, 2022 •

edited

Loading

YOU54F commented Oct 21, 2022


		A "work in progress" pact is a pact that is the latest for its tag that does not have any successful verification results (ie. is still pending) for the configured provider tag . At this stage in the exercise, the `feat/new-field` pact is still in pending state for the `master` branch of the provider, so it is considered a "work in progress" pact for master.
		A "work in progress" pact is a pact that is the latest for its branch that does not have any successful verification results (ie. is still pending) for the configured provider branch . At this stage in the exercise, the `feat/new-field` pact is still in pending state for the main branch of the provider, so it is considered a "work in progress" pact for `master`.

docs: CI/CD update - branches / contract_requiring_verification_published webhook #149

docs: CI/CD update - branches / contract_requiring_verification_published webhook #149

Conversation

YOU54F commented Oct 4, 2022 • edited Loading

bethesque Oct 4, 2022

Choose a reason for hiding this comment

YOU54F Oct 7, 2022

Choose a reason for hiding this comment

bethesque commented Oct 4, 2022

YOU54F commented Oct 7, 2022

bethesque commented Oct 18, 2022

bethesque Oct 18, 2022

Choose a reason for hiding this comment

bethesque Oct 18, 2022

Choose a reason for hiding this comment

bethesque Oct 18, 2022

Choose a reason for hiding this comment

bethesque Oct 18, 2022

Choose a reason for hiding this comment

bethesque Oct 20, 2022

Choose a reason for hiding this comment

bethesque commented Oct 18, 2022

netlify bot commented Oct 21, 2022 • edited Loading

✅ Deploy Preview for docs-pactflow-preview ready!

YOU54F commented Oct 21, 2022

YOU54F commented Oct 4, 2022 •

edited

Loading

netlify bot commented Oct 21, 2022 •

edited

Loading