[thirdparty/dracut.git] / docs / RELEASE.md

# Conducting A Successful Release

This documents contains the necessary steps to conduct a successful release.

1. Add all items to `NEWS.md`

    Get a first template with [`clog`](https://github.com/clog-tool/clog-cli)
    ```console
    $ clog -F -r https://github.com/dracutdevs/dracut
    ```

2. Update the contributors list in NEWS.md

   Produce the list with:
   ```console
   $ make CONTRIBUTORS
   ```

   Append the list to the section in `NEWS.md`

3. Update AUTHORS

   ```console
   $ make AUTHORS
   ```

4. Check in AUTHORS and NEWS.md

   ```console
   $ git ci -m "docs: update NEWS.md and AUTHORS" NEWS.md AUTHORS
   ```

5. Tag the release and push

   ```console
   $ VERSION=052
   $ git tag -s "$VERSION"
   $ git push --tags
   ```

   Add the section from `NEWS.md` to the git tag message.

6. Push git to kernel.org

   With:
   ```console
   $ git remote add kernelorg ssh://gitolite@ra.kernel.org/pub/scm/boot/dracut/dracut.git
   ```

   Push to kernel.org git:
   ```console
   $ git push --atomic kernelorg master "$VERSION"
   ```


7. Sign and upload tarballs to kernel.org

   ```console
   $ make upload
   ```

   This requires `kup` and a kernel.org account.
   Wait until the tarballs are synced to http://www.kernel.org/pub/linux/utils/boot/dracut/ .

8. Create a new release on github (https://github.com/dracutdevs/dracut/releases/new)
   - Add the section from `NEWS.md` to the release.
   - Attach the tarballs and signature file from http://www.kernel.org/pub/linux/utils/boot/dracut/ to the github release.

9. Close the github milestone and open a new one (https://github.com/dracutdevs/dracut/milestones)
10. Ensure that announcement was sent and reached the linux-initramfs mailinglist (https://www.spinics.net/lists/linux-initramfs/)
Commit	Line	Data
ebac18ba	1	# Conducting A Successful Release
0b86c060 HH	2
	3	This documents contains the necessary steps to conduct a successful release.
	4
	5	1. Add all items to `NEWS.md`
	6
	7	Get a first template with [`clog`](https://github.com/clog-tool/clog-cli)
	8	```console
62f3a10d	9	$ clog -F -r https://github.com/dracutdevs/dracut
0b86c060 HH	10	```
	11
	12	2. Update the contributors list in NEWS.md
	13
	14	Produce the list with:
	15	```console
	16	$ make CONTRIBUTORS
	17	```
	18
	19	Append the list to the section in `NEWS.md`
	20
	21	3. Update AUTHORS
	22
	23	```console
	24	$ make AUTHORS
	25	```
	26
	27	4. Check in AUTHORS and NEWS.md
	28
	29	```console
	30	$ git ci -m "docs: update NEWS.md and AUTHORS" NEWS.md AUTHORS
	31	```
	32
895c2f65	33	5. Tag the release and push
0b86c060 HH	34
	35	```console
	36	$ VERSION=052
	37	$ git tag -s "$VERSION"
895c2f65	38	$ git push --tags
0b86c060 HH	39	```
	40
	41	Add the section from `NEWS.md` to the git tag message.
	42
	43	6. Push git to kernel.org
	44
	45	With:
	46	```console
	47	$ git remote add kernelorg ssh://gitolite@ra.kernel.org/pub/scm/boot/dracut/dracut.git
	48	```
	49
	50	Push to kernel.org git:
	51	```console
62f3a10d	52	$ git push --atomic kernelorg master "$VERSION"
0b86c060 HH	53	```
	54
	55
	56	7. Sign and upload tarballs to kernel.org
	57
	58	```console
	59	$ make upload
	60	```
	61
	62	This requires `kup` and a kernel.org account.
895c2f65	63	Wait until the tarballs are synced to http://www.kernel.org/pub/linux/utils/boot/dracut/ .
0b86c060	64
895c2f65 HH	65	8. Create a new release on github (https://github.com/dracutdevs/dracut/releases/new)
	66	- Add the section from `NEWS.md` to the release.
	67	- Attach the tarballs and signature file from http://www.kernel.org/pub/linux/utils/boot/dracut/ to the github release.
0b86c060	68
895c2f65 HH	69	9. Close the github milestone and open a new one (https://github.com/dracutdevs/dracut/milestones)
895c2f65 HH	70	10. Ensure that announcement was sent and reached the linux-initramfs mailinglist (https://www.spinics.net/lists/linux-initramfs/)