Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

Issue 31 changelog #39

Merged
merged 3 commits into from
Jul 8, 2019
Merged

Issue 31 changelog #39

merged 3 commits into from
Jul 8, 2019

Conversation

sssoleileraaa
Copy link
Contributor

Description

Resolves #137

Adds a new changelog file and updates readme's release section to include adding changelog entries.

Copy link
Contributor

@kushaldas kushaldas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can just copy paste the existing changelog from the packaging repository to fill it up with the old content. Example: https://raw.githubusercontent.com/freedomofpress/securedrop-debian-packaging/master/securedrop-proxy/debian/changelog

@sssoleileraaa
Copy link
Contributor Author

sssoleileraaa commented Jul 5, 2019

How does this process and format look?

  1. Create changelog entry in this repo, e.g.:
## 0.1.4

  * Update urllib3 to version 1.24.3 or later due to CVE-2019-11324 (#35)
  * Remove pipenv in favor of pip-tools (#33)
  1. Create a debian package and update the debian package changelog in the securedrop-debian-packaging repo, e.g.:
securedrop-proxy (0.1.4) unstable; urgency=medium

  * [See securedrop-proxy changelog](https://github.com/freedomofpress/securedrop-proxy/blob/master/changelog.md#0140)

 -- Allie Crevier <[email protected]>  Tues, 18 Jun 2019 15:55:27 -0400

@kushaldas
Copy link
Contributor

I would still say to follow the proper debian changelog style, as people don't prefer to open a link to read about the changelog.

@sssoleileraaa
Copy link
Contributor Author

Ah, so we could remove the link and just copy-paste the changelog entry into the securedrop-debian-packaging repo, like so:

  1. Create changelog entry in this repo, e.g.:
## 0.1.4

  * Update urllib3 to version 1.24.3 or later due to CVE-2019-11324 (#35)
  * Remove pipenv in favor of pip-tools (#33)
  1. Create a debian package and add the debian package changelog (using dch and copy-pasting bullets from other changelog) in the securedrop-debian-packaging repo, e.g.:
securedrop-proxy (0.1.4) unstable; urgency=medium

  * Update urllib3 to version 1.24.3 or later due to CVE-2019-11324 (#35)
  * Remove pipenv in favor of pip-tools (#33)

 -- Allie Crevier <[email protected]>  Tues, 18 Jun 2019 15:55:27 -0400

How does this sound @kushaldas? The idea is to keep the changelog in the securedrop-client and securedrop-proxy repos simple to manually add and easier to read.

@redshiftzero
Copy link
Contributor

This idea sounds good to me (and since we have the changelog file in a standard location across our repos, we could also eventually have the packaging script populate the debian changelog)

Copy link
Contributor

@redshiftzero redshiftzero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should also add changelog.md to MANIFEST.in

Copy link
Contributor

@redshiftzero redshiftzero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great, thank you!

Copy link
Contributor

@kushaldas kushaldas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still personally feel that we should maintain changelogs in the debian package as they should be written. Saying that wearing my distro packager hat.

Approved. 🌈 Thank you.

@kushaldas kushaldas merged commit a7e0cce into master Jul 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[securedrop-proxy] create a changelog file
3 participants