Skip to content

Commit

Permalink
feat: update profile readme
Browse files Browse the repository at this point in the history
Signed-off-by: JP-Ellis <[email protected]>
  • Loading branch information
JP-Ellis committed Jul 11, 2024
1 parent 66fec04 commit 9996218
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 72 deletions.
74 changes: 36 additions & 38 deletions .github/workflows/metrics.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
# Visit https://github.com/lowlighter/metrics/blob/master/action.yml for full reference
name: Metrics

on:
# Schedule updates (once at midnight)
schedule: [{cron: "0 0 * * *"}]
# Lines below let you run workflow manually and on each commit
workflow_dispatch:
push: {branches: ["master", "main"]}
schedule:
- cron: "0 0 * * *"
push:
branches:
- main
- master
- feat/*

jobs:
github-metrics:
runs-on: ubuntu-latest

permissions:
contents: write
pull-requests: write

steps:
- uses: lowlighter/metrics@latest
# Update metrics display on the front page.
# Ref: https://github.com/lowlighter/metrics

with:
# Your GitHub token
# The following scopes are required:
Expand All @@ -21,38 +32,25 @@ jobs:
# - repo (optional, if you want to include private repositories)
token: ${{ secrets.METRICS_TOKEN }}

# Options
filename: github-metrics.svg

user: pact-foundation
template: classic
base: header, activity, community, repositories, metadata
config_timezone: Europe/London
plugin_achievements: yes
plugin_achievements_display: detailed
plugin_achievements_secrets: yes
plugin_achievements_threshold: C
plugin_activity: yes
plugin_activity_days: 14
plugin_activity_filter: all
plugin_activity_limit: 5
plugin_activity_load: 300
plugin_activity_visibility: all
plugin_followup: yes
plugin_followup_sections: repositories
plugin_languages: yes
plugin_languages_analysis_timeout: 15
plugin_languages_categories: markup, programming
plugin_languages_colors: github
plugin_languages_limit: 8
plugin_languages_recent_categories: markup, programming
plugin_languages_recent_days: 14
plugin_languages_recent_load: 300
plugin_languages_sections: most-used
plugin_languages_threshold: 0%
plugin_lines: yes

# ReF: https://github.com/lowlighter/metrics/tree/master/source/plugins/core
config_display: regular
config_timezone: UTC
repositories_skipped: |
.github
docs.pact.io
pact.io
# Ref: https://github.com/lowlighter/metrics/blob/master/source/plugins/base/README.md
base: header, community, repositories, metadata
base_indepth: yes
repositories: 100

# Ref: https://github.com/lowlighter/metrics/blob/master/source/plugins/people/README.md
plugin_people: yes
plugin_people_limit: 24
plugin_people_size: 28
plugin_people_types: followers, following
plugin_repositories: yes
plugin_repositories_affiliations: owner
plugin_repositories_batch: 100
plugin_people_limit: 36
plugin_people_types: members, contributors
63 changes: 29 additions & 34 deletions PROFILE/README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,42 @@
# Pact - Integration testing done properly
# Pact

> Fast, easy and reliable testing for integrating web apps, APIs and microservices
<!-- markdownlint-disable no-inline-html -->

## Say goodbye to end-to-end testing
<div align="center"><table><tr><td>
<b>Pact</b> is the de-facto API contract testing tool. Replace expensive and brittle end-to-end integration tests with fast, reliable and easy to debug unit tests.

> Testing microservices shouldn't involve setting up complex end-to-end test environments, creating lengthy integration suites and managing test data. Stop wasting time, and start releasing.
<ul style="list-style-type: none">
<li>⚡ Lightning fast</li>
<li>🎈 Effortless full-stack integration testing - from the front-end to the back-end</li>
<li>🔌 Supports HTTP/REST and event-driven systems</li>
<li>🛠️ Configurable mock server</li>
<li>😌 Powerful matching rules prevents brittle tests</li>
<li>🤝 Integrates with Pact Broker / PactFlow for powerful CI/CD workflows</li>
<li>🔡 Supports 12+ languages</li>
</ul>

- [Pact.io](https://pact.io/)
- [docs.pact.io](https://docs.pact.io/)
- [slack.pact.io](https://slack.pact.io/)
<b>Why use Pact?</b> Contract testing with Pact lets you:

### Find bugs in dev
![dev](https://raw.githubusercontent.com/pact-foundation/pact.io/master/pages/assets/img/icons/theme/devices/laptop-macbook.svg)
Prevent integration issues before you commit, instead of in production or during integration test Prevent integration issues before you commit, instead of in production or during integration test
<ul style="list-style-type: none">
<li>⚡ Test locally</li>
<li>🚀 Deploy faster</li>
<li>⬇️ Reduce the lead time for change</li>
<li>💰 Reduce the cost of API integration testing</li>
<li>💥 Prevent breaking changes</li>
<li>🔎 Understand your system usage</li>
<li>📃 Document your APIs for free</li>
<li>🗄 Remove the need for complex data fixtures</li>
<li>🤷‍♂️ Reduce the reliance on complex test environments</li>
</ul>

### Deploy faster, safer & more often
![dev](https://raw.githubusercontent.com/pact-foundation/pact.io/master/pages/assets/img/icons/theme/general/thunder-move.svg)
Pact provides a guarantee that systems are compatible, so you can deploy your microservices and web apps independently and safely
Watch our <a href="https://www.youtube.com/playlist?list=PLwy9Bnco-IpfZ72VQ7hce8GicVZs7nm0i">series</a> on the problems with end-to-end integrated tests, and how contract testing can help.

### Remove complex end-to-end environments
![dev](https://raw.githubusercontent.com/pact-foundation/pact.io/master/pages/assets/img/icons/theme/devices/server.svg)
Reduce (or removing entirely) the need for complex, costly and hard-to-manage integration test environments
</td></tr></table></div>

### Stop relying on unreliable test data
![dev](https://raw.githubusercontent.com/pact-foundation/pact.io/master/pages/assets/img/icons/theme/files/deleted-file.svg)
Finding and managing test data is a key pain point for engineering teams - with Pact, you can significantly reduce your reliance on flakey test data
<!-- markdownlint-enable no-inline-html -->

### Say goodbye to painful release processes
![wave](https://raw.githubusercontent.com/pact-foundation/pact.io/master/pages/assets/img/icons/theme/general/smile.svg)
With Pact and the Pact Broker, you can orchestrate complex CI and CD pipelines and use can-i-deploy to tell you when a component is safe to release

### Collaborate with the Pact Broker
![Collaborate](https://raw.githubusercontent.com/pact-foundation/pact.io/master/pages/assets/img/icons/theme/communication/group.svg)
Integrate into your CI/CD pipelines, manage and promote contracts with the Pact Broker

### Work offline with API stubs
![Work](https://raw.githubusercontent.com/pact-foundation/pact.io/master/pages/assets/img/icons/theme/devices/router-1.svg)
Pact's API stubs are guaranteed to represent behaviour of the real system, so you can test with confidence

### Create bulletproof pipelines
![Create](https://raw.githubusercontent.com/pact-foundation/pact.io/master/pages/assets/img/icons/theme/code/option.svg)
Pact CLI tools + Pact Broker = powerful automation capabilities

## Stats

![Metrics](https://github.com/pact-foundation/.github/blob/master/github-metrics.svg)
![Metrics](./github-metrics.svg)

0 comments on commit 9996218

Please sign in to comment.