Skip to content

Conversation

@yunks128
Copy link
Contributor

Purpose

Introduce a simplified approach for collecting DORA metrics in single-repository projects using GitHub Actions.

Proposed Changes

  • [ADD] Section on DeveloperMetrics GitHub Action as an alternative to DevLake
  • [ADD] Quick start example YAML for easy integration
  • [UPDATE] Clarified use cases and tool selection guidance based on project complexity

Issues

Testing

  • Verified markdown rendering locally

@yunks128 yunks128 requested a review from riverma April 16, 2025 04:34
@riverma
Copy link
Collaborator

riverma commented Apr 16, 2025

I think I'll take a pass at this as well - to potentially deprecate Apache DevLake in the guide.

@riverma
Copy link
Collaborator

riverma commented Apr 22, 2025

@yunks128 - I think let's do a couple things before considering a merge:

  • (@yunks128) Move the workflow action to '/assets'
  • (@yunks128) Show examples of the GH metrics badges so people know what it looks like
  • (@yunks128) Explain how the badge works / gets updated
  • (@riverma) Deprecate Apache DevLake content (if we do deprecate, we should be clear about the versioned released o the SLIM website)

Copy link
Collaborator

@riverma riverma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yunks128 - I really like how you've separated the "simple" vs "complex" content. I'm wondering if we can make the reading a bit more clear by doing the following: have two guides, where one talks about the simpler tool via the README route and the second talks about using DevLake for multi-repository use cases. The reason is having both in one file is a bit hard to read and go through - I'm thinking having two sub-guides might just be cleaner. What do you think?

Something like how we have multiple guides for the security topic, each talking about different tools for different use cases: https://nasa-ammos.github.io/slim/docs/category/security

Also, in each one, we can then have the "Quick Start" and "Step-by-Step" sections without needing an extra "Tool Options" section in each. Basically, we can follow our template guide more closely.

@sonarqubecloud
Copy link

sonarqubecloud bot commented May 8, 2025

@riverma riverma added medium complexity Ticket is relatively straightforward but may have a difficult sub-task more requested Requested by community members at a medium level software lifecycle Process improvements involving developing, testing, integrating, deploying software labels Jun 5, 2025
@yunks128 yunks128 self-assigned this Jul 2, 2025
@yunks128 yunks128 requested a review from riverma July 2, 2025 17:44
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jul 2, 2025

@yunks128
Copy link
Contributor Author

yunks128 commented Jul 2, 2025

@riverma I took another pass and resolved the conflict in registry.json. It should be all set for your review now—thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

medium complexity Ticket is relatively straightforward but may have a difficult sub-task more requested Requested by community members at a medium level software lifecycle Process improvements involving developing, testing, integrating, deploying software

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants