Replace Launchpad references with GitHub Issues #3955

TheRealFalcon · 2023-05-12T16:27:25Z

Proposed Commit Message

Replace Launchpad references with GitHub Issues

This should be ready for review

TheRealFalcon · 2023-05-12T16:29:13Z

SECURITY.md

-
-After the bug is received, the issue is triaged within 2 working days of
-being reported and a response is sent to the reporter.
+If a security bug is found, please send an email to


There was talk of GitHub supporting private security bugs, but we still need to investigate, so this section may change soon.

We can followup in the future when discussed w/ security about best practices

blackboxsw · 2023-05-15T15:24:10Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -11,7 +11,7 @@ no particular length requirements.

 If you need to write multiple paragraphs, feel free.

-LP: #NNNNNNN (replace with the appropriate bug reference or remove


I'd prefer we still document that if the issue is tagged launchpad and has an LP reference, we still want an LP: #ID footer supplement as well as the Fixes: #NNNN. Then launchpad automation will still mark the "expired" bug as fix released for us once we publish to Ubuntu. This gives launchpad bug filers a feedback mechanism that state has changed toward resolution for the bug.

+LP: #NNNN (if a source Launchpad bug is associated with the GitHub issue fixed)

I don't think Launchpad automation does that for upstream bugs. I think that's only for Ubuntu(cloud-init). That's why this has been part of our upstream release process.

Ohh sorry, right, but that part of the release process relies on us processing the git log commit messages to obtain said LP: # numbers. Do we not want to represent the released context to LP in this case? It seems to be a good way to close the loop on an otherwise 'Expired' bug status. If we provide those footers, and run through our post-release process, it would be an easy 'Fix Released' closure for upstream bugs that were formerly in the 'Expired' case. GH automation should close the GH Issue for us the moment we merge a commit on main with Fixes: #NNN footer.

blackboxsw · 2023-05-15T16:48:31Z

doc/rtd/howto/bugs.rst

-.. _Launchpad: https://launchpad.net/
-.. _Create a Launchpad account: https://help.launchpad.net/YourAccount/NewAccount
-.. _Report an upstream cloud-init bug: https://bugs.launchpad.net/cloud-init/+filebug
+.. _GitHub: https://github.com/canonical/cloud-init/issues


To align with more detail link anchor text above.

Suggested change

.. _GitHub: https://github.com/canonical/cloud-init/issues

.. _GitHub issues: https://github.com/canonical/cloud-init/issues

blackboxsw

We have a WIP-ONGOING-REFACTORIZATION.rst link that needs updating

diff --git a/WIP-ONGOING-REFACTORIZATION.rst b/WIP-ONGOING-REFACTORIZATION.rst
index f401af4ec..800f690c9 100644
--- a/WIP-ONGOING-REFACTORIZATION.rst
+++ b/WIP-ONGOING-REFACTORIZATION.rst
@@ -309,5 +309,5 @@ References
 .. _this comment in PR #363: https://github.com/canonical/cloud-init/pull/363#issuecomment-628829489
 .. _abstractmethod: https://docs.python.org/3/library/abc.html#abc.abstractmethod
 .. _type aliases: https://docs.python.org/3/library/typing.html#type-aliases
-.. _the list of bugs tagged net-refactor: https://bugs.launchpad.net/cloud-init/+bugs?field.tag=net-refactor
+.. _the list of bugs tagged net-refactor: https://github.com/canonical/cloud-init/issues?q=is%3Aissue+is%3Aopen+net-refactor

james.txt

blackboxsw · 2023-05-15T17:40:22Z

doc/rtd/explanation/events.rst

@@ -73,7 +73,7 @@ metadata, ``cloud-init`` will also bring up/down the newly added interface.
 .. warning::
   Due to its use of ``systemd`` sockets, ``hotplug`` functionality is
   currently incompatible with SELinux. This issue is being `tracked
-   on Launchpad`_. Additionally, ``hotplug`` support is considered
+   here`_. Additionally, ``hotplug`` support is considered


For links and link discovery for web crawlers, it is best to keep the link text content relevant to the destination you are going to. So we don't generally want generic words like "tracked here" but "tracked in GitHub #3890" .

blackboxsw · 2023-05-15T17:48:36Z

doc/rtd/howto/bugs.rst

@@ -6,7 +6,7 @@ Reporting bugs
 In this guide, we will show you how to:

 1) Collect logs to support your bug report.
-2) File bugs to the upstream ``cloud-init`` project via `Launchpad`_.
+2) File bugs to the upstream ``cloud-init`` project via `GitHub`_.


Suggested change

2) File bugs to the upstream ``cloud-init`` project via `GitHub`_.

2) File bugs to the upstream ``cloud-init`` project via `GitHub issues`_.

blackboxsw · 2023-05-15T17:49:57Z

SECURITY.md

-
-After the bug is received, the issue is triaged within 2 working days of
-being reported and a response is sent to the reporter.
+If a security bug is found, please send an email to


We can followup in the future when discussed w/ security about best practices

blackboxsw · 2023-05-15T18:08:21Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -11,7 +11,7 @@ no particular length requirements.

 If you need to write multiple paragraphs, feel free.

-LP: #NNNNNNN (replace with the appropriate bug reference or remove


+LP: #NNNN (if a source Launchpad bug is associated with the GitHub issue fixed)

blackboxsw

We have a WIP-ONGOING-REFACTORIZATION.rst link that needs updating

diff --git a/WIP-ONGOING-REFACTORIZATION.rst b/WIP-ONGOING-REFACTORIZATION.rst
index f401af4ec..800f690c9 100644
--- a/WIP-ONGOING-REFACTORIZATION.rst
+++ b/WIP-ONGOING-REFACTORIZATION.rst
@@ -309,5 +309,5 @@ References
 .. _this comment in PR #363: https://github.com/canonical/cloud-init/pull/363#issuecomment-628829489
 .. _abstractmethod: https://docs.python.org/3/library/abc.html#abc.abstractmethod
 .. _type aliases: https://docs.python.org/3/library/typing.html#type-aliases
-.. _the list of bugs tagged net-refactor: https://bugs.launchpad.net/cloud-init/+bugs?field.tag=net-refactor
+.. _the list of bugs tagged net-refactor: https://github.com/canonical/cloud-init/issues?q=is%3Aissue+is%3Aopen+net-refactor

Here's a combined diff for my comments that you can decide on:

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 19004bd58..234fbc83f 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -13,6 +13,8 @@ If you need to write multiple paragraphs, feel free.
 
 Fixes: #NNNNN (replace with the appropriate bug reference or remove
 this line entirely if there is no associated bug)
+
+LP: #NNNN (if a source Launchpad bug is associated with the GitHub issue fixed)

Additional Context

diff --git a/WIP-ONGOING-REFACTORIZATION.rst b/WIP-ONGOING-REFACTORIZATION.rst
index f401af4ec..800f690c9 100644
--- a/WIP-ONGOING-REFACTORIZATION.rst
+++ b/WIP-ONGOING-REFACTORIZATION.rst
@@ -309,5 +309,5 @@ References
.. _this comment in PR #363: #363 (comment)
.. _abstractmethod: https://docs.python.org/3/library/abc.html#abc.abstractmethod
.. _type aliases: https://docs.python.org/3/library/typing.html#type-aliases
-.. _the list of bugs tagged net-refactor: https://bugs.launchpad.net/cloud-init/+bugs?field.tag=net-refactor
+.. _the list of bugs tagged net-refactor: https://github.com/canonical/cloud-init/issues?q=is%3Aissue+is%3Aopen+net-refactor

diff --git a/doc/rtd/explanation/events.rst b/doc/rtd/explanation/events.rst
index f7da12268..a202033b6 100644
--- a/doc/rtd/explanation/events.rst
+++ b/doc/rtd/explanation/events.rst
@@ -73,7 +73,7 @@ metadata, cloud-init will also bring up/down the newly added interface.
.. warning::
Due to its use of systemd sockets, hotplug functionality is
currently incompatible with SELinux. This issue is being `tracked

here`_. Additionally, hotplug support is considered

in GitHub selinux cloud-init-hotplugd.socket not having permissions to fifo sockets #3890`_. Additionally, hotplug support is considered
experimental for non-Debian-based systems.

Example
@@ -92,4 +92,4 @@ On every boot, apply network configuration found in the datasource.
when: ['boot']

.. _Cloud-init: https://launchpad.net/cloud-init
-.. _tracked here: #3890
+.. _tracked in Github #3890: #3890
diff --git a/doc/rtd/howto/bugs.rst b/doc/rtd/howto/bugs.rst
index 376949058..6174cc712 100644
--- a/doc/rtd/howto/bugs.rst
+++ b/doc/rtd/howto/bugs.rst
@@ -6,7 +6,7 @@ Reporting bugs
In this guide, we will show you how to:

Collect logs to support your bug report.
-2) File bugs to the upstream cloud-init project via GitHub.
+2) File bugs to the upstream cloud-init project via GitHub issues.
Report issues for distro-specific packages.

Collect logs
@@ -103,7 +103,7 @@ To file a bug against the Arch package of cloud-init please use the
details.

.. LINKS:
-.. _GitHub: https://github.com/canonical/cloud-init/issues
+.. _GitHub issues: https://github.com/canonical/cloud-init/issues
.. _Report an upstream cloud-init bug: https://github.com/canonical/cloud-init/issues
.. _Ubuntu bug tracker: https://bugs.launchpad.net/ubuntu/+source/cloud-init/+filebug
.. Debian bug tracker: https://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=cloud-init;dist=unstable
diff --git a/doc/rtd/reference/network-config-format-eni.rst b/doc/rtd/reference/network-config-format-eni.rst
index f89fdb46b..06c945a64 100644
--- a/doc/rtd/reference/network-config-format-eni.rst
+++ b/doc/rtd/reference/network-config-format-eni.rst
@@ -17,5 +17,5 @@ This can happen in either :ref:datasource_nocloud or
Please reference existing documentation for the
:file:/etc/network/interfaces(5) format.

-.. _Cloud-init: https://launchpad.net/cloud-init
+.. _Cloud-init: https://github.com/canonical/cloud-init#cloud-init
.. _documentation: http://manpages.ubuntu.com/manpages/trusty/en/man5/interfaces.5.html
diff --git a/doc/rtd/reference/network-config.rst b/doc/rtd/reference/network-config.rst
index f7289c258..cb3e75da9 100644
--- a/doc/rtd/reference/network-config.rst
+++ b/doc/rtd/reference/network-config.rst
@@ -316,7 +316,7 @@ Example output:
USERCTL=no

-.. _Cloud-init: https://launchpad.net/cloud-init
+.. _Cloud-init: https://github.com/canonical/cloud-init#cloud-init
.. _LXD: https://linuxcontainers.org/lxd/docs/master/cloud-init/#custom-network-configuration
.. _NetworkManager: https://networkmanager.dev
.. _Netplan: https://netplan.io/

TheRealFalcon · 2023-05-15T18:56:54Z

Are the network-config*.rst changes actually used anywhere? I didn't update them because they weren't related to bug tracking, but now that I look, I don't see them referenced anywhere at all. So can we just remove them? I'll try and see what happens...

TheRealFalcon · 2023-05-15T18:58:29Z

Thanks for the review and the diff. I think I addressed or commented on all of your comments.

blackboxsw · 2023-05-15T19:18:58Z

Are the network-config*.rst changes actually used anywhere? I didn't update them because they weren't related to bug tracking, but now that I look, I don't see them referenced anywhere at all. So can we just remove them? I'll try and see what happens...

Yes those reference anchors are used in the following:

doc/rtd/reference/network-config.rst: - :ref:network_config_v1
doc/rtd/reference/datasources/nocloud.rst::ref:network_config_v1 or :ref:network_config_v2 by providing that
doc/rtd/reference/datasources/lxd.rst
doc/rtd/reference/datasources/vmware.rst
doc/rtd/howto/predeploy_testing.rst

TheRealFalcon · 2023-05-15T20:15:01Z

Sorry if I'm missing something obvious, but I'm not seeing those references. Can you point one out? Also, docs built without error. Wouldn't a missing reference produce an error?

blackboxsw · 2023-05-15T21:04:01Z

Sorry if I'm missing something obvious, but I'm not seeing those references. Can you point one out? Also, docs built without error. Wouldn't a missing reference produce an error?

You are not, I misread your comment. Ahh, it's a typo in the network-config*rst files actual links should have been referenced at the top of network-config-eni.rst and network-config.rst as
`Cloud-init`_ instead of ``Cloud-init``. But I think dropping them is fine as you have already done.

blackboxsw

+1 thanks @TheRealFalcon

Replace Launchpad references with GitHub Issues

e28a411

TheRealFalcon added the wip Work in progress, do not land label May 12, 2023

TheRealFalcon commented May 12, 2023

View reviewed changes

TheRealFalcon added documentation This Pull Request changes documentation and removed wip Work in progress, do not land labels May 15, 2023

blackboxsw reviewed May 15, 2023

View reviewed changes

blackboxsw requested changes May 15, 2023

View reviewed changes

comments

46ab57b

github-actions bot removed the documentation This Pull Request changes documentation label May 15, 2023

comments

f476d66

blackboxsw approved these changes May 15, 2023

View reviewed changes

blackboxsw merged commit ce2f26c into canonical:main May 15, 2023

TheRealFalcon deleted the migration-updates branch October 16, 2023 12:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace Launchpad references with GitHub Issues #3955

Replace Launchpad references with GitHub Issues #3955

TheRealFalcon commented May 12, 2023 •

edited

Loading

TheRealFalcon May 12, 2023

blackboxsw May 15, 2023

blackboxsw May 15, 2023 •

edited

Loading

blackboxsw May 15, 2023

TheRealFalcon May 15, 2023

blackboxsw May 15, 2023 •

edited

Loading

blackboxsw May 15, 2023 •

edited

Loading

blackboxsw left a comment •

edited

Loading

blackboxsw May 15, 2023

blackboxsw May 15, 2023

blackboxsw May 15, 2023

blackboxsw May 15, 2023

blackboxsw left a comment

TheRealFalcon commented May 15, 2023

TheRealFalcon commented May 15, 2023

blackboxsw commented May 15, 2023

TheRealFalcon commented May 15, 2023

blackboxsw commented May 15, 2023

blackboxsw left a comment

		@@ -11,7 +11,7 @@ no particular length requirements.

		If you need to write multiple paragraphs, feel free.

		LP: #NNNNNNN (replace with the appropriate bug reference or remove

	.. _GitHub: https://github.com/canonical/cloud-init/issues
	.. _GitHub issues: https://github.com/canonical/cloud-init/issues

	2) File bugs to the upstream ``cloud-init`` project via `GitHub`_.
	2) File bugs to the upstream ``cloud-init`` project via `GitHub issues`_.

Replace Launchpad references with GitHub Issues #3955

Replace Launchpad references with GitHub Issues #3955

Conversation

TheRealFalcon commented May 12, 2023 • edited Loading

Proposed Commit Message

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blackboxsw May 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blackboxsw May 15, 2023 • edited Loading

Choose a reason for hiding this comment

blackboxsw May 15, 2023 • edited Loading

Choose a reason for hiding this comment

blackboxsw left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blackboxsw left a comment

Choose a reason for hiding this comment

Additional Context

TheRealFalcon commented May 15, 2023

TheRealFalcon commented May 15, 2023

blackboxsw commented May 15, 2023

TheRealFalcon commented May 15, 2023

blackboxsw commented May 15, 2023

blackboxsw left a comment

Choose a reason for hiding this comment

TheRealFalcon commented May 12, 2023 •

edited

Loading

blackboxsw May 15, 2023 •

edited

Loading

blackboxsw May 15, 2023 •

edited

Loading

blackboxsw May 15, 2023 •

edited

Loading

blackboxsw left a comment •

edited

Loading