Skip to content

Commit

Permalink
chore: add description for renovate regex and rules (#531)
Browse files Browse the repository at this point in the history
  • Loading branch information
@huxuan
huxuan authored May 8, 2024
1 parent e247360 commit c23da50
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 14 deletions.
25 changes: 18 additions & 7 deletions .renovaterc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
{
"customType": "regex",
"datasourceTemplate": "pypi",
"description": "Match Python packages installed with pip, pipx and asdf",
"fileMatch": [
"^README\\.md$",
"^\\.devcontainer/Dockerfile$",
Expand All @@ -30,7 +31,8 @@
{
"customType": "regex",
"datasourceTemplate": "repology",
"depTypeTemplate": "apt",
"depTypeTemplate": "debian",
"description": "Match debian packages installed in Dockerfiles",
"fileMatch": [
"^\\.devcontainer\\/Dockerfile$",
"^template\\/\\.devcontainer/Dockerfile\\.jinja$"
Expand All @@ -44,6 +46,7 @@
"customType": "regex",
"datasourceTemplate": "github-tags",
"depNameTemplate": "pdm-project/pdm",
"description": "Match pdm version specified in setup-pdm GitHub Action",
"fileMatch": [
"^\\.github/workflows/.+\\.yml$",
"^template/.*\\.github.*/workflows/.+\\.yml(\\.jinja)?$"
Expand All @@ -57,6 +60,7 @@
"customType": "regex",
"datasourceTemplate": "github-runners",
"depTypeTemplate": "github-runner",
"description": "Match GitHub runner defined in GitHub Actions matrix strategy",
"fileMatch": [
"^\\.github/workflows/.+\\.yml$",
"^template/.*\\.github.*/workflows/.+\\.yml(\\.jinja)?$"
Expand All @@ -71,6 +75,7 @@
"datasourceTemplate": "git-tags",
"depNameTemplate": "https://github.com/serious-scaffold/ss-python.git",
"depTypeTemplate": "copier-template",
"description": "Match template version specified in .copier-answers.yml",
"fileMatch": [
"^\\.copier-answers\\.yml$"
],
Expand All @@ -92,6 +97,7 @@
},
"packageRules": [
{
"description": "Update GitHub Action in template",
"matchDepTypes": [
"action"
],
Expand All @@ -103,6 +109,7 @@
}
},
{
"description": "Update GitHub Runner in template",
"matchDepTypes": [
"github-runner"
],
Expand All @@ -113,6 +120,7 @@
}
},
{
"description": "Update pre-commit hooks in template",
"matchManagers": [
"pre-commit"
],
Expand All @@ -123,6 +131,7 @@
}
},
{
"description": "Update container images in template",
"matchDepTypes": [
"container",
"image",
Expand All @@ -137,6 +146,7 @@
}
},
{
"description": "Update python packages in template",
"matchDatasources": [
"pypi"
],
Expand All @@ -149,6 +159,7 @@
},
{
"commitMessageTopic": "serious-scaffold-python",
"description": "Update template with copier when a new version is released",
"matchDepTypes": [
"copier-template"
],
Expand All @@ -162,7 +173,7 @@
"semanticCommitScope": "copier-template"
},
{
"description": "Group pdm in Dockerfile and GitHub Action",
"description": "Group pdm Python package and version specified in setup-pdm GitHub Action",
"groupName": "pdm",
"matchDatasources": [
"github-tags",
Expand All @@ -175,7 +186,7 @@
},
{
"description": "Group renovate docker tag and pre-commit-hooks tag",
"groupName": "renovate tag",
"groupName": "renovate",
"matchDatasources": [
"docker",
"github-tags"
Expand All @@ -187,14 +198,14 @@
]
},
{
"description": "Group apt packages to avoid failure when multiple packages are outdated.",
"groupName": "apt packages",
"description": "Group debian packages to avoid failure when multiple packages are outdated",
"groupName": "debian packages",
"matchDepTypes": [
"apt"
"debian"
]
},
{
"description": "Pre-commit 3.5.0 is pinned as the last version supporting Python 3.8.",
"description": "Pre-commit 3.5.0 is pinned as the last version supporting Python 3.8",
"enabled": false,
"matchCurrentVersion": "==3.5.0",
"matchPackageNames": [
Expand Down
25 changes: 18 additions & 7 deletions template/.renovaterc.json.jinja
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
{
"customType": "regex",
"datasourceTemplate": "pypi",
"description": "Match Python packages installed with pip, pipx and asdf",
"fileMatch": [
"^README\\.md$",
"^\\.devcontainer/Dockerfile$",
Expand Down Expand Up @@ -33,7 +34,8 @@
{
"customType": "regex",
"datasourceTemplate": "repology",
"depTypeTemplate": "apt",
"depTypeTemplate": "debian",
"description": "Match debian packages installed in Dockerfiles",
"fileMatch": [
"^\\.devcontainer\\/Dockerfile$"
[%- if project_name == "Serious Scaffold Python" %],
Expand All @@ -49,6 +51,7 @@
"customType": "regex",
"datasourceTemplate": "github-tags",
"depNameTemplate": "pdm-project/pdm",
"description": "Match pdm version specified in setup-pdm GitHub Action",
"fileMatch": [
"^\\.github/workflows/.+\\.yml$"
[%- if project_name == "Serious Scaffold Python" %],
Expand All @@ -64,6 +67,7 @@
"customType": "regex",
"datasourceTemplate": "github-runners",
"depTypeTemplate": "github-runner",
"description": "Match GitHub runner defined in GitHub Actions matrix strategy",
"fileMatch": [
"^\\.github/workflows/.+\\.yml$",
"^template/.*\\.github.*/workflows/.+\\.yml(\\.jinja)?$"
Expand All @@ -78,6 +82,7 @@
"datasourceTemplate": "git-tags",
"depNameTemplate": "https://github.com/serious-scaffold/ss-python.git",
"depTypeTemplate": "copier-template",
"description": "Match template version specified in .copier-answers.yml",
"fileMatch": [
"^\\.copier-answers\\.yml$"
],
Expand All @@ -102,6 +107,7 @@
"packageRules": [
[%- if project_name == "Serious Scaffold Python" %]
{
"description": "Update GitHub Action in template",
"matchDepTypes": [
"action"
],
Expand All @@ -113,6 +119,7 @@
}
},
{
"description": "Update GitHub Runner in template",
"matchDepTypes": [
"github-runner"
],
Expand All @@ -123,6 +130,7 @@
}
},
{
"description": "Update pre-commit hooks in template",
"matchManagers": [
"pre-commit"
],
Expand All @@ -133,6 +141,7 @@
}
},
{
"description": "Update container images in template",
"matchDepTypes": [
"container",
"image",
Expand All @@ -147,6 +156,7 @@
}
},
{
"description": "Update python packages in template",
"matchDatasources": [
"pypi"
],
Expand All @@ -160,6 +170,7 @@
[%- endif %]
{
"commitMessageTopic": "serious-scaffold-python",
"description": "Update template with copier when a new version is released",
"matchDepTypes": [
"copier-template"
],
Expand All @@ -173,7 +184,7 @@
"semanticCommitScope": "copier-template"
},
{
"description": "Group pdm in Dockerfile and GitHub Action",
"description": "Group pdm Python package and version specified in setup-pdm GitHub Action",
"groupName": "pdm",
"matchDatasources": [
"github-tags",
Expand All @@ -186,7 +197,7 @@
},
{
"description": "Group renovate docker tag and pre-commit-hooks tag",
"groupName": "renovate tag",
"groupName": "renovate",
"matchDatasources": [
"docker",
"github-tags"
Expand All @@ -202,14 +213,14 @@
]
},
{
"description": "Group apt packages to avoid failure when multiple packages are outdated.",
"groupName": "apt packages",
"description": "Group debian packages to avoid failure when multiple packages are outdated",
"groupName": "debian packages",
"matchDepTypes": [
"apt"
"debian"
]
},
{
"description": "Pre-commit 3.5.0 is pinned as the last version supporting Python 3.8.",
"description": "Pre-commit 3.5.0 is pinned as the last version supporting Python 3.8",
"enabled": false,
"matchCurrentVersion": "==3.5.0",
"matchPackageNames": [
Expand Down

0 comments on commit c23da50

Please sign in to comment.