Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 52 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,56 @@
# Gitify Organization Public Profile
# 🧩 Gitify Organization

The [public profile](profile/README.md) for [Gitify][gitify-website] organization on GitHub.
[![Renovate enabled][renovate-badge]][renovate] [![Renovate config validation][validator-badge]][validator-actions] [![Conventional Commits][commits-badge]][commits] [![License][license-badge]][license]

> Shared configuration and community health files for the [Gitify][gitify-website] organization.
> See the [organization profile](profile/README.md).

---

## 📦 Shared Renovate configuration

This repository hosts the organization's shared [Renovate][renovate] preset, inherited by every Gitify repository.

| File | Purpose |
| ---------------------- | ----------------------------------------------------------------------------------------------- |
| `default.json` | Baseline preset every repository inherits via `extends: ["github>gitify-app/.github"]`. |
| `renovate-config.json` | Onboarding entry point (`extends: ["./default"]`); Renovate suggests it automatically for new repositories. |

## 🔗 Inheriting and extending

A repository inherits the baseline by extending the shared preset, then adds its own configuration after it. Repository-level settings and later `packageRules` take precedence:

```jsonc
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["github>gitify-app/.github"],
"packageRules": [
{ "description": "repo-specific rule" }
]
}
```

## 🛠️ Policy

- 🗓️ Weekly updates, with grouped Vite+ and GitHub Actions updates.
- 🟢 Node runtime tracks LTS only; `@types/node` majors are handled per repository.
- 🛡️ OSV vulnerability alerts on; no automerge in the baseline.

## ✅ Validation

`default.json`, `renovate-config.json`, and any other preset files are validated with `renovate-config-validator --strict` by [`.github/workflows/renovate-config-validator.yml`](.github/workflows/renovate-config-validator.yml). Consumer repositories call the same reusable workflow to validate their own `renovate.json`.

## 📄 License

Released under the [MIT License](LICENSE).

<!-- LINK LABELS -->
[gitify-website]: https://gitify.io
[renovate]: https://renovatebot.com/
[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovate&logoColor=white
[validator-actions]: https://github.com/gitify-app/.github/actions/workflows/renovate-config-validator.yml
[validator-badge]: https://img.shields.io/github/actions/workflow/status/gitify-app/.github/renovate-config-validator.yml?logo=github&label=renovate%20config
[commits]: https://www.conventionalcommits.org/
[commits-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?logo=conventionalcommits&logoColor=white
[license]: LICENSE
[license-badge]: https://img.shields.io/github/license/gitify-app/.github?logo=github
11 changes: 10 additions & 1 deletion default.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,25 @@
":semanticCommitScope(deps)",
":separateMultipleMajorReleases",
":rebaseStalePrs",
"helpers:pinGitHubActionDigests",
"schedule:weekly",
"group:vitePlus",
"group:githubArtifactActions",
"customManagers:biomeVersions",
"helpers:pinGitHubActionDigestsToSemver"
],
"osvVulnerabilityAlerts": true,
"labels": ["dependency"],
"packageRules": [
{
"description": "Pin npm dependency ranges by default",
"matchManagers": ["npm"],
"rangeStrategy": "pin"
},
{
"description": "Keep engine ranges (for example node) as ranges rather than pinning them",
"matchDepTypes": ["engines"],
"rangeStrategy": "auto"
},
{
"description": "Use the dependency name in npm commit messages and PR titles",
"matchDatasources": ["npm"],
Expand Down
5 changes: 5 additions & 0 deletions renovate-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"description": "Onboarding entry point for gitify organization repositories",
"extends": ["./default"]
}
Loading