rpmautospec

https://fedora-infra.github.io/rpmautospec-docs/
Admin
rpmautospec is a program and library that automatically generates the release and changelog fields...
Tokens:7,741
Snippets:99
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Pre-Release Case Example

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autorelease.rst.txt

Using the -p parameter to designate a pre-release.

```spec
Name:           test-autorelease-prerelease
Version:        1.0
Release:        %autorelease -p -e pre1
Summary:        A test package for pre-release

License:        MIT

%description
%{summary}

%changelog
%autochangelog
```

--------------------------------

### Example Changelog File Content

Source: https://fedora-infra.github.io/rpmautospec-docs/autochangelog.html

This is an example of the content found in a package's changelog file. Note the formatting variations, particularly the absence of a hyphen between the email and version-release in some entries.

```text
* Mon Nov 25 2019 Foo Bar <foo@bar.com> 2.3.5-1
- Update to 2.3.5

* Wed Jul 25 2018 Foo Bar <foo@bar.com> 2.3.4-1
- Fix building for armv7 with gcc10 (required for the mass rebuild)

* Thu Feb 06 2020 John Doe <john@doe.com> - 1.5-2
- Fix building for armv7 with gcc10

* Thu Feb 06 2020 Foo Bar <foo@bar.com> - 1.5-1
- Update to 1.5

* Sat Jul 14 2018 Jane Smith <jane@smith.com> - 1.0-1
- Update to 1.0

* Mon Jun 18 2018 Jane Smith <jane@smith.com> - 0.9-1
- Initial import

```

--------------------------------

### Example: Commits and Changelog

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autochangelog.rst.txt

Shows how commits are prepended to an existing static changelog file.

```text
* Mon Nov 25 2019 Foo Bar <foo@bar.com> 2.3.5-1
- Update to 2.3.5

* Wed Jul 25 2018 Foo Bar <foo@bar.com> 2.3.4-1
- Fix building for armv7 with gcc10 (required for the mass rebuild)

* Thu Feb 06 2020 John Doe <john@doe.com> - 1.5-2
- Fix building for armv7 with gcc10

* Thu Feb 06 2020 Foo Bar <foo@bar.com> - 1.5-1
- Update to 1.5

* Sat Jul 14 2018 Jane Smith <jane@smith.com> - 1.0-1
- Update to 1.0
```

--------------------------------

### Snapshot and Extraver Case Example

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autorelease.rst.txt

Combining -e and -s parameters for complex versioning.

```spec
Name:           test-autorelease-extraver-snapshot
Version:        1.0
Release:        %autorelease -e pre1 -s 20200317git1234abcd
Summary:        A test package with extraver and snapshot info

License:        MIT

%description
%{summary}

%changelog
%autochangelog
```

--------------------------------

### Example: Only Commits

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autochangelog.rst.txt

Demonstrates how git history is converted into a changelog when no static changelog file exists.

```text
F:  Update to 2.3.4
|
E:  Fix build on arm64
|
|   Fixes bug introduced in previous commit.
|   [skip changelog]
|
D:  Fix building on armv7 with gcc10
|
|   ... (required for the mass rebuild).
|
C:  Update to 1.5
|
B:  Update to 1.0
|
A:  Initial import
```

```text
* Wed Jul 25 2018 Foo Bar <foo@bar.com> - 2.3.4-1
- Update to 2.3.4

* Thu Feb 06 2020 John Doe <john@doe.com> - 1.5-2
- Fix building for armv7 with gcc10 (required for the mass rebuild)

* Thu Feb 06 2020 Foo Bar <foo@bar.com> - 1.5-1
- Update to 1.5

* Sat Jul 14 2018 Jane Smith <jane@smith.com> - 1.0-1
- Update to 1.0

* Mon Jun 18 2018 Jane Smith <jane@smith.com> - 0.9-1
- Initial import
```

--------------------------------

### Snapshot Case Example

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autorelease.rst.txt

Using the -s parameter to specify snapshot information.

```spec
Name:           test-autorelease-snapshot
Version:        1.0
Release:        %autorelease -s 20200317git1234abcd
Summary:        A test package with snapshot info

License:        MIT

%description
%{summary}

%changelog
%autochangelog
```

--------------------------------

### Simple Autorelease Example

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autorelease.rst.txt

Basic usage of the %autorelease macro in a spec file.

```spec
Name:           test-autorelease
Version:        1.0
Release:        %autorelease
Summary:        A simple test package

License:        MIT

%description
%{summary}

%changelog
%autochangelog
```

--------------------------------

### Extraver Case Example

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autorelease.rst.txt

Using the -e parameter to specify the extraver portion.

```spec
Name:           test-autorelease-extraver
Version:        1.0
Release:        %autorelease -e pre1
Summary:        A test package with extraver

License:        MIT

%description
%{summary}

%changelog
%autochangelog
```

--------------------------------

### Git history to full changelog generation

Source: https://fedora-infra.github.io/rpmautospec-docs/autochangelog.html

Example of how a sequence of git commits is processed into a complete package changelog.

```text
F:  Update to 2.3.4
|
E:  Fix build on arm64
|
|   Fixes bug introduced in previous commit.
|   [skip changelog]
|
D:  Fix building on armv7 with gcc10
|
|   ... (required for the mass rebuild).
|
C:  Update to 1.5
|
B:  Update to 1.0
|
A:  Initial import

```

```text
* Wed Jul 25 2018 Foo Bar <foo@bar.com> - 2.3.4-1
- Update to 2.3.4

* Thu Feb 06 2020 John Doe <john@doe.com> - 1.5-2
- Fix building for armv7 with gcc10 (required for the mass rebuild)

* Thu Feb 06 2020 Foo Bar <foo@bar.com> - 1.5-1
- Update to 1.5

* Sat Jul 14 2018 Jane Smith <jane@smith.com> - 1.0-1
- Update to 1.0

* Mon Jun 18 2018 Jane Smith <jane@smith.com> - 0.9-1
- Initial import

```

--------------------------------

### Custom Base Release Example

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autorelease.rst.txt

Using the -b parameter to set a custom base release number.

```spec
Name:           test-autorelease-baserelease
Version:        1.0
Release:        %autorelease -b 100
Summary:        A test package with a custom base release

License:        MIT

%description
%{summary}

%changelog
%autochangelog
```

--------------------------------

### Example Commit History

Source: https://fedora-infra.github.io/rpmautospec-docs/autochangelog.html

This illustrates a typical commit history relevant to changelog generation. Commits are identified by letters, and some contain annotations like '[skip changelog]'.

```text
K:  Fix build on s390x
|
|   [skip changelog]
|
J:  Update to 2.4
|
I:  Fix typo in the changelog file
|
H:  Fix typo in patch001
|
G:  Move changelog to ``changelog`` and fix typo
|
F:  Update to 2.3.5
|
E:  Update to 2.3.4
|
D:  Fix building on armv7 with gcc10
|
C:  Update to 1.5
|
B:  Update to 1.0
|
A:  Initial import

```

--------------------------------

### Custom Base Release Usage

Source: https://fedora-infra.github.io/rpmautospec-docs/autorelease.html

Implementation using the -b parameter to set a starting release number other than 1.

```spec
Summary:    test-autorelease-baserelease
Name:       test-autorelease-baserelease
Version:    1.0
Release:    %autorelease -b 100
License:    MIT

%description
An example package for the %%autorelease macro.

This package demonstrates using a base release number which lets release numbers start at other
values than 1 (the default).
```

```text
test-autorelease-baserelease-1.0-100.fc34.x86_64
```

--------------------------------

### View rpmautospec header in spec file

Source: https://fedora-infra.github.io/rpmautospec-docs/peculiarities.html

Example of the metadata header injected by rpmautospec into the preprocessed spec file during build time.

```text
## START: Set by rpmautospec
## (rpmautospec version 0.3.0)
## RPMAUTOSPEC: autorelease, autochangelog
...
## END: Set by rpmautospec

```

--------------------------------

### Generated Changelog Example

Source: https://fedora-infra.github.io/rpmautospec-docs/autochangelog.html

This is the resulting changelog generated by rpmautospec, combining commit messages and the existing changelog content. It demonstrates how commits after the last changelog entry are included, and how '[skip changelog]' annotations are respected.

```text
* Mon Mar 02 2020 Jane Smith <jane@smith.com> - 2.4-1
- Update to 2.4

* Mon Nov 25 2019 Foo Bar <foo@bar.com> 2.3.5-1
- Update to 2.3.5

* Wed Jul 25 2018 Foo Bar <foo@bar.com> 2.3.4-1
- Update to 2.3.4

* Thu Feb 06 2020 John Doe <john@doe.com> - 1.5-2
- Fix building for armv7 with gcc10 (required for the mass rebuild)

* Thu Feb 06 2020 Foo Bar <foo@bar.com> - 1.5-1
- Update to 1.5

* Sat Jul 14 2018 Jane Smith <jane@smith.com> - 1.0-1
- Update to 1.0

* Mon Jun 18 2018 Jane Smith <jane@smith.com> - 0.9-1
- Initial import

```

--------------------------------

### Pre-Release Case Usage

Source: https://fedora-infra.github.io/rpmautospec-docs/autorelease.html

Implementation using -p and -e parameters for pre-release versioning.

```spec
Summary:    test-autorelease-prerelease
Name:       test-autorelease-prerelease
Version:    1.0
Release:    %autorelease -p -e pre1
License:    MIT

%description
An example package testing the %%autorelease macro. This package is for
testing a prerelease with an <extraver> part, when upstream uses unsortable
versions like "1.0pre1".
```

```text
test-autorelease-prerelease-1.0-0.1.pre1.fc34.x86_64
```

--------------------------------

### Simple commit message to changelog entry

Source: https://fedora-infra.github.io/rpmautospec-docs/autochangelog.html

Demonstrates how a standard commit summary is transformed into a formatted changelog entry.

```text
Update to version 2.3.4 (rhbz#666)

This also fixes build issues on arm64.

```

```text
* Mon Nov 25 2019 Foo Bar <foo@bar.com> 2.3.4-1
- Update to version 2.3.4 (rhbz#666)

```

--------------------------------

### Preview Generated Changelog with rpmautospec

Source: https://fedora-infra.github.io/rpmautospec-docs/autochangelog.html

Use the `rpmautospec generate-changelog` command to preview the changelog output before committing. This command helps in verifying the changelog generation process.

```bash
rpmautospec generate-changelog
```

--------------------------------

### Bump Release via Commit Log

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autorelease.rst.txt

Use a magic comment in the commit log to force a minimum release number.

```text
[bump release: <number>]
```

--------------------------------

### Configure autorelease for snapshot and extra versioning

Source: https://fedora-infra.github.io/rpmautospec-docs/autorelease.html

Combine the -e and -s flags to handle both extra versioning and snapshot information within the release field.

```spec
Summary:    test-autorelease-extraver-snapshot
Name:       test-autorelease-extraver-snapshot
Version:    1.0
Release:    %autorelease -e pre1 -s 20200317git1234abcd
License:    MIT

%description
An example package testing the %%autorelease macro. This package is for
testing with <extraver> and <snapinfo> parts, when upstream uses unsortable
versions like "1.0pre1" and we package a snapshot after it.
```

```text
test-autorelease-extraver-snapshot-1.0-1.pre1.20200317git1234abcd.fc34.x86_64
```

--------------------------------

### Extended commit message to changelog entry

Source: https://fedora-infra.github.io/rpmautospec-docs/autochangelog.html

Shows how to include additional details and list items in a changelog entry using ellipses and dashes.

```text
Update to version 2.3.5

... (rhbz#667, rhbz#123, and a few other nasty bugs)
- Fixes build issues on s390 (rhbz#668)

(Text without a dash is ignored.)

```

```text
* Mon Nov 26 2019 Foo Bar <foo@bar.com> 2.3.5-1
- Update to version 2.3.5 (rhbz#667, rhbz#123, and a few other nasty bugs)
- Fixes build issues on s390 (rhbz#668)

```

--------------------------------

### Generate simple changelog entry from commit

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autochangelog.rst.txt

The first line of a commit message becomes the changelog entry, with authorship and date added automatically.

```text
Update to version 2.3.4 (rhbz#666)

This also fixes build issues on arm64.
```

```text
* Mon Nov 25 2019 Foo Bar <foo@bar.com> 2.3.4-1
- Update to version 2.3.4 (rhbz#666)
```

--------------------------------

### Generate extended changelog entry

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autochangelog.rst.txt

Use an ellipsis to append body text to the first entry and add subsequent lines as separate dashed items.

```text
Update to version 2.3.5

... (rhbz#667, rhbz#123, and a few other nasty bugs)
- Fixes build issues on s390 (rhbz#668)

(Text without a dash is ignored.)
```

```text
* Mon Nov 26 2019 Foo Bar <foo@bar.com> 2.3.5-1
- Update to version 2.3.5 (rhbz#667, rhbz#123, and a few other nasty bugs)
- Fixes build issues on s390 (rhbz#668)
```

--------------------------------

### Simple %autorelease Usage

Source: https://fedora-infra.github.io/rpmautospec-docs/autorelease.html

Standard implementation of the %autorelease macro in a spec file.

```spec
Summary:    test-autorelease
Name:       test-autorelease
Version:    1.0
Release:    %autorelease
License:    MIT

%description
An example package testing the %%autorelease macro. This package is for
testing the normal release cadence, bumping in the left-most, most significant
place of the release field.
```

```text
test-autorelease-1.0-1.fc34.x86_64
```

--------------------------------

### Create empty rebuild commit

Source: https://fedora-infra.github.io/rpmautospec-docs/peculiarities.html

Command to trigger a package rebuild without modifying source files by creating an empty git commit.

```bash
git commit --allow-empty -m 'Rebuild for …'

```

--------------------------------

### Traditional Versioning Structure

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autorelease.rst.txt

Extended release field format for legacy versioning requirements.

```spec
<pkgrel>[.<extraver>][.<snapinfo>]%{?dist}[.<minorbump>]
```

--------------------------------

### Configure autorelease for snapshot versioning

Source: https://fedora-infra.github.io/rpmautospec-docs/autorelease.html

Use the -s flag with the %autorelease macro to include snapshot information in the release field.

```spec
Summary:    test-autorelease-snapshot
Name:       test-autorelease-snapshot
Version:    1.0
Release:    %autorelease -s 20200317git1234abcd
License:    MIT

%description
An example package testing the %%autorelease macro. This package is for
testing with a <snapinfo> part, for a snapshot between versions from an
upstream repository.
```

```text
test-autorelease-snapshot-1.0-1.20200317git1234abcd.fc34.x86_64
```

--------------------------------

### Convert Existing Changelog with rpmautospec

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/opting-in.rst.txt

Use the 'rpmautospec convert' command to automatically move existing changelog entries from your spec file to a separate 'changelog' file in your git repository. This must be done in a single commit.

```console
$ rpmautospec convert
```

--------------------------------

### Create Empty Commit for Rebuilds

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/peculiarities.rst.txt

To rebuild a package without code changes (e.g., for dependency updates), create an empty commit using `git commit --allow-empty`. This commit can then be pushed and built normally.

```bash
git commit --allow-empty -m 'Rebuild for …'
```

--------------------------------

### Extraver Case Usage

Source: https://fedora-infra.github.io/rpmautospec-docs/autorelease.html

Implementation using the -e parameter to specify extra version information.

```spec
Summary:    test-autorelease-extraver
Name:       test-autorelease-extraver
Version:    1.0
Release:    %autorelease -e pre1
License:    MIT

%description
An example package testing the %%autorelease macro. This package is for
testing with an <extraver> part, when upstream uses unsortable versions like
"1.0pre1".
```

```text
test-autorelease-extraver-1.0-1.pre1.fc34.x86_64
```

--------------------------------

### Add %autochangelog Macro for New Packages

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/opting-in.rst.txt

For new packages without git history, add %changelog and %autochangelog at the end of your spec file. This will automatically generate a changelog from the package's git commit history.

```spec
%changelog
%autochangelog
```

--------------------------------

### Skip changelog entry

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autochangelog.rst.txt

Include the specific tag on a separate line to exclude a commit from the generated changelog.

```text
[skip changelog]
```

--------------------------------

### Skip changelog entry

Source: https://fedora-infra.github.io/rpmautospec-docs/autochangelog.html

Use the [skip changelog] tag to prevent a commit from appearing in the generated changelog.

```text
[skip changelog]

```

--------------------------------

### Define Release Field Structure

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/autorelease.rst.txt

The standard format for the release field in an RPM spec file.

```spec
<pkgrel>%{?dist}[.<minorbump>]
```

--------------------------------

### Replace Release with %autorelease Macro

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/opting-in.rst.txt

Replace the manually set release number in your spec file with the %autorelease macro for automatic release management. Consider switching just before a version bump to avoid an initial jump in the release number.

```spec
Release:    7{%dist}
```

```spec
Release:    %autorelease
```

--------------------------------

### Handle unresolvable merge changelog

Source: https://fedora-infra.github.io/rpmautospec-docs/peculiarities.html

The output format displayed by rpmautospec when it cannot automatically resolve changelog entries during a merge.

```text
- RPMAUTOSPEC: unresolvable merge

```

--------------------------------

### rpmautospec Information in Spec File Header

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/peculiarities.rst.txt

rpmautospec adds a header to preprocessed spec files, indicating its version and the features used. This information is available in the generated SRPM.

```spec
## START: Set by rpmautospec
## (rpmautospec version 0.3.0)
## RPMAUTOSPEC: autorelease, autochangelog
...
## END: Set by rpmautospec
```

--------------------------------

### Marking Unresolvable Merge in Changelog

Source: https://fedora-infra.github.io/rpmautospec-docs/_sources/peculiarities.rst.txt

When rpmautospec encounters an unresolvable merge commit in the history, it flags the changelog entry. Manual intervention is required to resolve this by incorporating changes from affected branches.

```text
- RPMAUTOSPEC: unresolvable merge
```
Tokens:
Raw