bcgov / DITP-DevOps

Digital Identity and Trust Program Team's DevOps Documentation Repository
Apache License 2.0
2 stars 6 forks source link

Add/Update Dependabot configuration files to/in select GitHub repos used by our team(s) #175

Closed WadeBarnes closed 2 weeks ago

WadeBarnes commented 8 months ago

Add or update Dependabot Configuration files to/in select repositories to better automate updates and dependency management of the associated code.

By default, Dependabot scans repositories containing dependency lock files for updates to address vulnerabilities. This behavior can be extended to include scanning code within a repository for updated versions. We've started using this feature for maintaining the dependencies for GitHub actions across several BCGov, Hyperledger, and Open Wallet Foundation repos, and we'd like to expand that to the rest of the code base(s).

Approach:

  1. Determine which repositories should be considered in scope for this task. Repositories from the bcgov, hyperledger, and openwallet-foundation should be considered. Discuss with the DITP team members and the community members activity working on the code within these various organizations to compile a list of candidate repositories.
  2. Determine the most appropriate Dependabot configuration settings for each repository. Settings are expected to vary from repository to repository based on the associated code base. Discuss with the DITP team and the community members who are actively contributing and maintaining code within the identified repositories to determine the most appropriate settings.
  3. Draft PRs for each selected repository, complete with the Dependabot configuration settings designed for each repository.

Acceptance Criteria:

  1. Acceptance criteria may vary depending on the repository and the community maintaining it. Acceptance will ultimately be decided by maintainer review and approval of the submitted PR. However, in general is expected to be based on a complete, functional, and easily maintainable Dependabot configuration file containing settings appropriately configured for the given repository.
rajpalc7 commented 7 months ago

Hi @WadeBarnes , Please let me know if I am missing any other repositories that will require dependabot configuration files than the ones mentioned below:

https://github.com/search?q=topic%3Adts+org%3Abcgov+fork%3Atrue&type=repositories

https://github.com/search?q=topic%3Aaca-py+org%3Ahyperledger+fork%3Atrue&type=repositories

https://github.com/search?q=topic%3Aindy+org%3Aopenwallet-foundation+fork%3Atrue&type=repositories

https://github.com/search?q=topic%3Aaries+org%3Aopenwallet-foundation+fork%3Atrue&type=repositories

WadeBarnes commented 7 months ago

Thanks @rajpalc7. The following queries provide a more complete list of the candidate repositories in each of the Organizations:

rajpalc7 commented 7 months ago

Thanks @WadeBarnes I noticed some of the repositories already have dependabot.yml in it. If we are planning to update it, how would you like the new update to look like ?

WadeBarnes commented 7 months ago

Thanks @WadeBarnes I noticed some of the repositories already have dependabot.yml in it. If we are planning to upgrade the, how would you like the new upgrade to look like ?

Add or update Dependabot Configuration files. That's what the ticket asks for.

What, if anything, needs to be added or updated depends on the repository, the code it contains, and how well the exiting configuration manages the code within that repository. So without a specific example, I can't really answer that question.

A general example:

rajpalc7 commented 7 months ago

`BC Gov Repositories:

rajpalc7 commented 7 months ago

HYPERLEDGER:

OPENWALLET:

WadeBarnes commented 7 months ago

Based on developer feedback we've determined from filtering of the version update recommendations is required to minimize PR "noise". Refer to https://github.com/bcgov/vc-authn-oidc/issues/465 for an example.

WadeBarnes commented 7 months ago

Top 5 list of repositories to work on is being maintained here; https://github.com/bcgov/DITP-DevOps/issues/174#issuecomment-2026007556

WadeBarnes commented 7 months ago

@rajpalc7, please check off the repositories in the lists above as you complete the tasks and the PRs are successfully merged.

WadeBarnes commented 7 months ago

@rajpalc7, As we move forward please focus on and complete the work in the BC Gov repositories first. When you complete that check in with @cvarjao and I on how to proceed with the Hyperledger and Open Wallet Foundation repositories.