cloud-init

Merge ~raharper/cloud-init:doc/update-hacking-docs into cloud-init:master

  1. Git
  2. lp:~raharper/cloud-init
  3. doc/update-hacking-docs
  4. Merge into master
Proposed by Ryan Harper
Status: Merged
Approved by: Chad Smith
Approved revision: 72b25f05d4c0ff35e6c370244b1069c2c7fcfc18
Merge reported by: Server Team CI bot
Merged at revision: not available
Proposed branch: ~raharper/cloud-init:doc/update-hacking-docs
Merge into: cloud-init:master
Diff against target: 167 lines (+54/-38)
2 files modified
HACKING.rst (+52/-36)
doc/rtd/topics/tests.rst (+2/-2)
Reviewer Review Type Date Requested Status
Server Team CI bot continuous-integration Approve
Chad Smith Approve
Review via email: mp+375297@code.launchpad.net

Commit message

doc: update launchpad git refs to github

To post a comment you must log in.
Revision history for this message
Chad Smith (chad.smith) wrote :

minor corrections here. thanks!

review: Needs Fixing
Revision history for this message
Server Team CI bot (server-team-bot) wrote :

PASSED: Continuous integration, rev:3776f25d65c2eacce6ad244c3fd37c168782ccfb
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1278/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    IN_PROGRESS: Declarative: Post Actions

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1278//rebuild

review: Approve (continuous-integration)
~raharper/cloud-init:doc/update-hacking-docs updated
72b25f0... by Ryan Harper

Tell users to fork from GitHub account first, fix clone url

Revision history for this message
Chad Smith (chad.smith) wrote :

Perfect.

review: Approve
Revision history for this message
Server Team CI bot (server-team-bot) wrote :

PASSED: Continuous integration, rev:72b25f05d4c0ff35e6c370244b1069c2c7fcfc18
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1279/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    IN_PROGRESS: Declarative: Post Actions

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1279//rebuild

review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
diff --git a/HACKING.rst b/HACKING.rst
index fcdfa4f..8c8e518 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -3,18 +3,40 @@ Hacking on cloud-init
3*********************3*********************
44
5This document describes how to contribute changes to cloud-init.5This document describes how to contribute changes to cloud-init.
6It assumes you have a `Launchpad`_ account, and refers to your launchpad user6It assumes you have a `GitHub`_ account, and refers to your GitHub user
7as ``LP_USER`` throughout.7as ``GH_USER`` throughout.
88
9Do these things once9Do these things once
10====================10====================
1111
12* To contribute, you must sign the Canonical `contributor license agreement`_12* To contribute, you must sign the Canonical `contributor license agreement`_
1313
14 If you have already signed it as an individual, your Launchpad user will be listed in the `contributor-agreement-canonical`_ group. Unfortunately there is no easy way to check if an organization or company you are doing work for has signed. If you are unsure or have questions, email `Josh Powers <mailto:josh.powers@canonical.com>`_ or ping powersj in ``#cloud-init`` channel via freenode.14 If you have already signed it as an individual, your Launchpad user will be
15 listed in the `contributor-agreement-canonical`_ group. Unfortunately there
16 is no easy way to check if an organization or company you are doing work for
17 has signed. When signing the CLA and prompted for 'Project contact' or
18 'Canonical Project Manager' enter 'Josh Powers'.
1519
16 When prompted for 'Project contact' or 'Canonical Project Manager' enter20 For existing contributors who've already signed the agreement, we can verify
17 'Josh Powers'.21 the link between your `Launchpad`_ account and your `GitHub`_ account by
22 creating a branch with both your Launchpad and GitHub usernames into both
23 Launchpad and GitHub cloud-init repositories. We've added a tool
24 (tools/migrate-lp-user-to-github) to the cloud-init repository to handle this
25 migration as automatically as possible.
26
27 The cloud-init team will review the two merge proposals and verify
28 that the CLA has been signed for the Launchpad user and record the
29 associated GitHub account. We will reply to the email address
30 associated with your Launchpad account that you've been clear to
31 contribute to cloud-init on GitHub.
32
33 If your company has signed the CLA for you, please contact us to help
34 in verifying which launchad/GitHub accounts are associated with the
35 company. For any questions or help with the process, please email:
36
37 `Josh Powers <mailto:josh.powers@canonical.com>`_ with the subject: Cloud-Init CLA
38
39 You also may contanct user ``powersj`` in ``#cloud-init`` channel via IRC freenode.
1840
19* Configure git with your email and name for commit messages.41* Configure git with your email and name for commit messages.
2042
@@ -24,26 +46,24 @@ Do these things once
24 git config user.name "Your Name"46 git config user.name "Your Name"
25 git config user.email "Your Email"47 git config user.email "Your Email"
2648
27* Clone the upstream `repository`_ on Launchpad::49* Sign into your `GitHub`_ account
2850
29 git clone https://git.launchpad.net/cloud-init51* Fork the upstream `repository`_ on Github and clicking on the ``Fork`` button
30 cd cloud-init
31
32 There is more information on Launchpad as a git hosting site in
33 `Launchpad git documentation`_.
3452
35* Create a new remote pointing to your personal Launchpad repository.53* Create a new remote pointing to your personal GitHub repository.
36 This is equivalent to 'fork' on github.
3754
38 .. code:: sh55 .. code:: sh
3956
40 git remote add LP_USER ssh://LP_USER@git.launchpad.net/~LP_USER/cloud-init57 git clone git://github.com/canonical/cloud-init
41 git push LP_USER master58 cd cloud-init
59 git remote add GH_USER git@github.com:GH_USER/cloud-init.git
60 git push GH_USER master
4261
43.. _repository: https://git.launchpad.net/cloud-init62.. _GitHub: https://github.com
63.. _Launchpad: https://launchpad.net
64.. _repository: https://github.com/canonical/cloud-init
44.. _contributor license agreement: http://www.canonical.com/contributors65.. _contributor license agreement: http://www.canonical.com/contributors
45.. _contributor-agreement-canonical: https://launchpad.net/%7Econtributor-agreement-canonical/+members66.. _contributor-agreement-canonical: https://launchpad.net/%7Econtributor-agreement-canonical/+members
46.. _Launchpad git documentation: https://help.launchpad.net/Code/Git
4767
48Do these things for each feature or bug68Do these things for each feature or bug
49=======================================69=======================================
@@ -61,29 +81,21 @@ Do these things for each feature or bug
6181
62 tox82 tox
6383
64* Push your changes to your personal Launchpad repository::84* Push your changes to your personal GitHub repository::
6585
66 git push -u LP_USER my-topic-branch86 git push -u GH_USER my-topic-branch
6787
68* Use your browser to create a merge request:88* Use your browser to create a merge request:
6989
70 - Open the branch on Launchpad.90 - Open the branch on GitHub
7191
72 - You can see a web view of your repository and navigate to the branch at:92 - You can see a web view of your repository and navigate to the branch at:
7393
74 ``https://code.launchpad.net/~LP_USER/cloud-init/``94 ``https://github.com/GH_USER/cloud-init/tree/my-topic-branch``
75
76 - It will typically be at:
77
78 ``https://code.launchpad.net/~LP_USER/cloud-init/+git/cloud-init/+ref/BRANCHNAME``
79
80 for example, here is larsks move-to-git branch: https://code.launchpad.net/~larsks/cloud-init/+git/cloud-init/+ref/feature/move-to-git
8195
82 - Click 'Propose for merging'96 - Click 'Pull Request`
83 - Select 'lp:cloud-init' as the target repository97 - Fill out the pull request title, summarizing the change and a longer
84 - Type '``master``' as the Target reference path98 message indicating important details about the changes included, like ::
85 - Click 'Propose Merge'
86 - On the next page, hit 'Set commit message' and type a git combined git style commit message like::
8799
88 Activate the frobnicator.100 Activate the frobnicator.
89101
@@ -100,12 +112,16 @@ Do these things for each feature or bug
100112
101 LP: #1113 LP: #1
102114
103Then, someone in the `cloud-init-dev`_ group will review your changes and115 Note that the project continues to use LP: #NNNNN format for closing
104follow up in the merge request.116 launchpad bugs rather than GitHub Issues.
117
118 - Click 'Create Pull Request`
119
120Then, someone in the `Ubuntu Server`_ team will review your changes and
121follow up in the pull request.
105122
106Feel free to ping and/or join ``#cloud-init`` on freenode irc if you123Feel free to ping and/or join ``#cloud-init`` on freenode irc if you
107have any questions.124have any questions.
108125
109.. _tox: https://tox.readthedocs.io/en/latest/126.. _tox: https://tox.readthedocs.io/en/latest/
110.. _Launchpad: https://launchpad.net127.. _Ubuntu Server: https://github.com/orgs/canonical/teams/ubuntu-server
111.. _cloud-init-dev: https://launchpad.net/~cloud-init-dev/+members#active
diff --git a/doc/rtd/topics/tests.rst b/doc/rtd/topics/tests.rst
index b83bd89..a2c703a 100644
--- a/doc/rtd/topics/tests.rst
+++ b/doc/rtd/topics/tests.rst
@@ -23,7 +23,7 @@ configuration users can run the integration tests via tox:
2323
24.. code-block:: shell-session24.. code-block:: shell-session
2525
26 $ git clone https://git.launchpad.net/cloud-init26 $ git clone https://github.com/canonical/cloud-init
27 $ cd cloud-init27 $ cd cloud-init
28 $ tox -e citest -- -h28 $ tox -e citest -- -h
2929
@@ -53,7 +53,7 @@ explaining how to run one or the other independently.
5353
54.. code-block:: shell-session54.. code-block:: shell-session
5555
56 $ git clone https://git.launchpad.net/cloud-init56 $ git clone https://github.com/canonical/cloud-init
57 $ cd cloud-init57 $ cd cloud-init
58 $ tox -e citest -- run --verbose \58 $ tox -e citest -- run --verbose \
59 --os-name stretch --os-name xenial \59 --os-name stretch --os-name xenial \

Subscribers

People subscribed via source and target branches