A simple, template-based, Node-powered dependabot.yml generator

• Dependabot Generator
  • Table of Contents
  • About the Project
    • Idea
    • Roadmap
      • General
      • Dependencies
      • CI/CD
      • Misc
  • Technologies
  • Usage
    • Creating template

This project is a simple Node-powered dependabot.yml generator. It is designed to be used in conjunction with Dependabot, a GitHub app that automates dependency updates.

Dependabot is a great tool, but it can be a bit of a pain to configure. This project aims to make that process a little easier by utilizing a JSON based templates to generate dependabot.yml file.

The idea for this project came to me when I started to using Dependabot Azure DevOps extension.

I work with projects that have multiple docker images, most of the time 5 or more.

I wanted to be able to generate dependabot.yml by just providing project path, so I started coding...

• Generate dependabot.yml file from provided template that handles asterisks and Docker images
• Example template generation
• Template validation
• Template duplicates detection
• Template auto fixing capability

• Multiple file name support (for ex. Dockerfile and dockerfile)

• Docker support ( Dockerfile )

• Npm support ( package.json )

• Pip support ( requirements.txt )

• Maven support ( pom.xml )

• Nuget support ( packages.config )

• Composer support ( composer.json )

• Gradle support ( build.gradle )

• Cargo support ( Cargo.toml )

• GitHub Actions ( auto deploy to NPM )
• Versioning
• Changelog
• Tests
• Code coverage
• Code quality
• Code style
• Code documentation

• DevOps pipeline support ( so it can be used as a task )
• CLI template generator
• Template documentation

This project is built with Node.js (version 18.10.0) and TypeScript (version 5.3.3).

I choose this due to fact that I started to build with in mind that it will be used as a CLI tool, also I really want to be able to run it anywhere.

From scratch I used JavaScript but due to fact that I wanted to have some type safety I switched to TypeScript, also I'm Angular developer so I'm used to it.

I wrote this as Draft and proof of concept, so I will clean my code and add some tests later on.

1. Install Node.js (version 18.10.0 or later)
2. Clone this repository

git clone https://github.com/Orholt/Dependabot-Generator.git

3. Install dependencies

npm install

4. Run the project

npm start

Note: You can also use npm start map to run the project (this will map template).

Note: You can also use npm start map --path <path> to run the project (this will map template from provided project path).

1. Create a new file in .github folder named dependabot_template.json

2. Follow template schema described in Template documentation