Skip to content

Commit

Permalink
update-existing-pkg: Add suitable shortlog examples
Browse files Browse the repository at this point in the history
The reasoning is the same as for the new packages.

The git shortlog examples shown in this in this commit have already
been proven useful in the context of the serpent recipe monorepo.

Signed-off-by: Rune Morling <ermo@serpentos.com>
  • Loading branch information
ermo committed Feb 28, 2024
1 parent 8ed1e23 commit 705b393
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/packaging/updating-an-existing-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,20 @@ Full release notes:
- [ ] Package was built and tested against unstable
```

### Other commit message format examples

In the cases where you are not updating a package to a new version, but simply applying a patch of fixing an existing version, the following commit message shortlogs are considered suitable:

Check warning on line 172 in docs/packaging/updating-an-existing-package.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (shortlogs)

- Add the `homepage` metatdata key:

Check warning on line 174 in docs/packaging/updating-an-existing-package.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (metatdata)
`package: Add homepage`
- Fix a packaging issue (including adding a patch to fix the package)
`package: Fix (...)`
- Updating a README, monitoring.yml file or other stuff that does not directly _change_ the package, meaning the package release number didn't need a bump:
`package: [NFC] Add README.md and monitoring.yml`
`[NFC]` is an abbreviation adopted from the clang compiler suite, which expands to "Non Functional Change".

The overall reasoning for the git shortlog formats shown above is to enable quick and efficient "at-a-glance" parsing of git shortlogs for Solus Staff.

Check warning on line 182 in docs/packaging/updating-an-existing-package.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (shortlog)

Check warning on line 182 in docs/packaging/updating-an-existing-package.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (shortlogs)

For more information on suitable commit messages, please check the [tooling central documentation](https://github.com/solus-project/tooling-central/blob/master/README.rst#using-git).

Next, you'll [submit a pull request for review](submitting-a-pull-request.md).

0 comments on commit 705b393

Please sign in to comment.