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

Creating a scorecard config skeleton file to assist with scorecard setup #59

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sadeliveroo
Copy link

PR: Add Skeleton Scorecard Manifest File

What is the Scorecard

The Scorecard is a brand new curated framework for assessing the operational maturity of an individual service against Deliveroo's engineering standards, providing a structured pathway from minimum compliance to industry excellence.

Deliveroo's manual service readiness process has been essential in ensuring our services are production-ready. However, it has been challenging to track the readiness of all services across the organisation and can often become stale as services evolve over time. The new Scorecard revamps the existing service readiness process into a largely automated and near-real-time tracker of your service's readiness and quality metrics. We will be launching the Scorecard over the next few weeks, so keep an eye out for more information!

Summary

Most metrics in the Scorecard are automatically evaluated, however some metrics require manual input from the owning team. This PR introduces a skeleton scorecard manifest file to the repository, allowing us to cover all aspects of the existing service readiness process and more - over time, we plan to shrink this file as we automate the evaluation of more and more Scorecard metrics.

Action Required

Please can you review and merge the skeleton manifest file into your repo. You are not required to fill in any information yet, further announcements about this will occur in the coming weeks. However, if you wish to see an example of a populated scorecard manifest file, you can do so in this example. Check out the config file documentation for more information too.

⚠️ Please note that these PRs are auto-generated and there are 501 of them in total across our org, so we won't be able to respond to individual requests for bespoke changes - please go ahead and make any necessary changes needed to the file to adapt to your repo. The Scorecard engine will scan for a .scorecard/config.yml file in your repo and will automatically evaluate the information supplied in the file.

🙏 Although we've added a to-stage label for repos that are using Marvin, not all repos are using Marvin or have a unique staging process, if the latter applies to you, please stage these changes yourself

✅ If you're happy with the changes, please can you go ahead and merge after you're reviewed to help us track progress - thank you!

Questions

If you have any questions, please reach out to us on Slack in the Scorecards Support channel.

@sadeliveroo sadeliveroo requested a review from a team as a code owner December 10, 2024 20:13
@sadeliveroo sadeliveroo self-assigned this Dec 10, 2024
Copy link

yamllint Failed

Show Output
::group::./.scorecard/config.yaml
::error file=./.scorecard/config.yaml,line=45,col=23::45:23 [new-line-at-end-of-file] no new line character at the end of file
::endgroup::

Workflow: Yamllint GitHub Actions, Action: __karancode_yamllint-github-action, Lint: .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant