diff --git a/Changelog.md b/Changelog.md index adb6bfd..805923e 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,3 +1,15 @@ +## [2.0.0](https://github.com/AtomiCloud/nix-registry/compare/v1.2.0...v2.0.0) (2025-02-02) + + +### ✨ New Packages ✨ + +* **infra:** infralint and infrautils, bundling of infra related tools ([0dd96d5](https://github.com/AtomiCloud/nix-registry/commit/0dd96d58808c6f68d2b2e5cb103c99f4d882e5d2)) + + +### ⬆️ Packages Updated ⬆️ + +* **sg:** update sg to 0.11.0 ([c2097c8](https://github.com/AtomiCloud/nix-registry/commit/c2097c8f683c5c886f49b3f34b122d58b3418996)) + ## [1.2.0](https://github.com/AtomiCloud/nix-registry/compare/v1.1.0...v1.2.0) (2025-01-29) diff --git a/docs/developer/CommitConventions.md b/docs/developer/CommitConventions.md index e8142c5..46dc56d 100644 --- a/docs/developer/CommitConventions.md +++ b/docs/developer/CommitConventions.md @@ -2,4 +2,132 @@ id: commit-conventions title: Commit Conventions --- -var__convention_docs__ +This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) loosely as the specification +for our commits. + +Commit message will be in the format: + +``` +type(scope): title + +body +``` + +This page will document the types and scopes used. + +# Types + +| Type | Description | +| ------------------- | --------------------------------------------------------- | +| [fix](#fix) | Fixed a bug within the repository | +| [new](#new) | Release a new package | +| [update](#update) | Update a package's version | +| [remove](#remove) | Remove package from the repository | +| [docs](#docs) | 📝 Add documentation 📝 | +| [ci](#ci) | Changed the CI pipeline | +| [release](#release) | Initiate a release (machine initiated) | +| [config](#config) | Update configuration of the repository | +| [chore](#chore) | Any chores, uncategorized, or small mistakes (like typos) | + +## fix + +Fixed a bug within the repository + +| **V.A.E** | V.A.E values | +| --------------- | ------------------------------------------------------------------ | +| verb | fix | +| application | when this commit is applied, it will _fix_ `` | +| example | fix: dropdown flickering | +| example applied | when this commit is applied, it will _fix_ **dropdown flickering** | + +| Scope | Description | Bump | +| -------- | ------------------------------------------ | ------- | +| default | Generic fixes not under `drv` or `patch` | `patch` | +| `drv` | Fixes in nix derivations in the repository | `patch` | +| `config` | Fixes in configuration | `nil` | + +## new + +Release a new package + +| **V.A.E** | V.A.E values | +| --------------- | --------------------------------------------------------------------------------------- | +| verb | add | +| application | when this commit is applied, it will _add_ `<scope>, <title>` | +| example | new(narwhal): a swiss army knife for docker | +| example applied | when this commit is applied, it will _add_ `narwhal`, **a swiss army knife for docker** | + +| Scope | Description | Bump | +| ------- | --------------------- | ------- | +| default | Release a new package | `minor` | + +## update + +Update a package's version + +| Scope | Description | Bump | +| ------- | -------------------------- | ------- | +| default | Update a package's version | `major` | + +## remove + +Remove package from the repository + +| Scope | Description | Bump | +| ------- | ----------------- | ------- | +| default | Removed a package | `major` | + +## docs + +📝 Add documentation 📝 + +| Scope | Description | Bump | +| ------- | ------------------------------------------------------------------ | ------- | +| default | Adds a generic documentation not related to `dev`, `pkg` or `user` | `nil` | +| `user` | Adds a user-side documentation | `nil` | +| `dev` | Adds a developer-side (contributing) documentation | `nil` | +| `pkg` | Updates a documentation on a package | `patch` | + +## ci + +Changed the CI pipeline + +| Scope | Description | Bump | +| ------- | ----------------------- | ----- | +| default | Update CI configuration | `nil` | + +## release + +Initiate a release (machine initiated) + +| Scope | Description | Bump | +| ------- | ------------------------- | ----- | +| default | Machine initiated release | `nil` | + +## config + +Update configuration of the repository + +| Scope | Description | Bump | +| -------- | ---------------------------------------------------------------------------- | ----- | +| default | Updates the configuration of the repository, not related to the other scopes | `nil` | +| `lint` | Add, update or remove linters | `nil` | +| `fmt` | Add, updatge or remove formatters | `nil` | +| `build` | Add, update or change buyild pipelines and generators | `nil` | +| `nix` | Add, update or change nix shell | `nil` | +| `env` | Add, update or change environment | `nil` | +| `ignore` | Add, update or change ignore configurations | `nil` | + +## chore + +Any chores, uncategorized, or small mistakes (like typos) + +| Scope | Description | Bump | +| ------- | ----------- | ----- | +| default | chores | `nil` | + +# Special Scopes + +| Scope | Description | Bump | +| ------------ | ------------------------------ | ----- | +| `no-release` | Prevent release from happening | `nil` |