Skip to content

Latest commit

 

History

History
164 lines (115 loc) · 4.37 KB

README.md

File metadata and controls

164 lines (115 loc) · 4.37 KB
Raw

renovate-config

GitHub tag (latest SemVer) Lint Issues Latest Release

A shareable config preset for Renovate used in Hadenlabs.

Usage

{
  "extends": ["github>hadenlabs/renovate-config"]
}

Available presets

autoMergePin

{
  "pin": {
    "automerge": true
  }
}

autoMergeTypesMinor

{
  "packageRules": [
    {
      "matchPackagePatterns": ["^@types/"],
      "automerge": true,
      "major": {
        "automerge": false
      }
    }
  ]
}

groupJest

Grouping jest monorepo packages and ts-jest.

{
  "packageRules": [
    {
      "groupName": "jest",
      "matchSourceUrlPrefixes": [
        "https://github.com/facebook/jest",
        "https://github.com/kulshekhar/ts-jest"
      ]
    }
  ]
}

groupLinters

Grouping lint-related packages for JavaScript and TypeScript. Adding prettier and typescript-eslint packages to the packages:linters preset.

{
  "packageRules": [
    {
      "groupName": "linters",
      "extends": ["packages:linters"],
      "matchPackageNames": ["prettier"],
      "matchPackagePatterns": ["^@typescript-eslint/"]
    }
  ]
}

schedule

{
  "extends": [":timezone(America/Lima)"],
  "schedule": ["after 10:30 before 18:00 every weekday except after 13:00 before 14:00"]
}

This config is heavily based on our business hours in Hadenlabs. So if this is not a good fit for you, please exclude as follows:

{
  "ignorePresets": ["github>hadenlabs/renovate-config:schedule"]
}

or extend the Schedule Presets.

Help

Got a question?

File a GitHub issue.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Development

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to rebase the latest changes from "upstream" before making a pull request!

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Using the given version number of MAJOR.MINOR.PATCH, we apply the following constructs:

  1. Use the MAJOR version for incompatible changes.
  2. Use the MINOR version when adding functionality in a backwards compatible manner.
  3. Use the PATCH version when introducing backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

  • In the context of initial development, backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
  • In the context of pre-release, backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

Copyright

Copyright © 2018-2021 Hadenlabs

Trademarks

All other trademarks referenced herein are the property of their respective owners.

License

The code and styles are licensed under the LGPL-3.0 license See project license..

Don't forget to 🌟 Star 🌟 the repo if you like renovate-config

Your feedback is appreciated