Skip to content

Commit 6b6c2a0

Browse files
committed
increase importance of pats by including it as a section in the tutorials
Signed-off-by: Kenji Brameld <[email protected]>
1 parent 6cc878a commit 6b6c2a0

File tree

5 files changed

+38
-78
lines changed

5 files changed

+38
-78
lines changed

source/How-To-Guides/Releasing/First-Time-Release.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ Install dependencies
2828

2929
.. include:: _Install-Dependencies.rst
3030

31+
Set Up a Personal Access Token
32+
------------------------------
33+
34+
.. include:: _Personal-Access-Token.rst
35+
3136
Ensure repositories are up-to-date
3237
----------------------------------
3338

@@ -52,10 +57,6 @@ Bump the package version
5257
Bloom Release
5358
-------------
5459

55-
.. note::
56-
57-
If you have two factor authorization enabled on GitHub, follow :doc:`GitHub Manual Authorization <GitHub-Manual-Authorization>` first.
58-
5960
Run the following command, replacing ``my_repo`` with the name of your repository:
6061

6162
.. code-block:: bash

source/How-To-Guides/Releasing/GitHub-Manual-Authorization.rst

Lines changed: 0 additions & 68 deletions
This file was deleted.

source/How-To-Guides/Releasing/Releasing-a-Package.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,9 @@ Releasing a Package
1515
Subsequent-Releases
1616
Release-Team-Repository
1717
Release-Track
18-
GitHub-Manual-Authorization
1918

2019
**Releasing a package makes your package available on the public ROS 2 buildfarm.**
21-
After you've created a package, this is the next step towards getting your package into the publicly available Debian packages!
20+
After you have created a package, this is the next step towards getting your package into the publicly available Debian packages!
2221

2322
Releasing your package onto the buildfarm will make your package available to be installed via package managers (eg. ``apt`` on Ubuntu) for all supported Linux platforms in a ROS distribution as described in `REP 2000 <https://ros.org/reps/rep-2000.html>`_.
2423

source/How-To-Guides/Releasing/Subsequent-Releases.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ Install dependencies
1717

1818
.. include:: _Install-Dependencies.rst
1919

20+
Set up a Personal Access Token
21+
------------------------------
22+
23+
.. include:: _Personal-Access-Token.rst
24+
2025
Ensure repositories are up-to-date
2126
----------------------------------
2227

@@ -41,10 +46,6 @@ Bump the package version
4146
Bloom Release
4247
-------------
4348

44-
.. note::
45-
46-
If you have two factor authorization enabled on GitHub, follow :doc:`GitHub Manual Authorization <GitHub-Manual-Authorization>` first.
47-
4849
Run the following command, replacing ``my_repo`` with the name of your repository with the packages:
4950

5051
.. code-block:: bash
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. warning::
2+
3+
If the file ``~/.config/bloom`` exists on your computer, it is likely that you have done this before so you should skip this section.
4+
5+
During the release process, multiple HTTPS Git operations will be performed that require password authentication.
6+
To avoid being repeatedly asked for a password, a `Personal Access Token (PAT) <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token>`_ will be set up.
7+
8+
Create a Personal Access Token by:
9+
10+
#. Log in to GitHub and go to `Personal access tokens <https://github.com/settings/tokens>`_.
11+
#. Click the **Generate new token** button.
12+
#. Set **Note** to something like ``Bloom token``.
13+
#. Set **Expiration** to **No expiration**.
14+
#. Tick the ``public_repo`` and ``workflow`` checkboxes.
15+
#. Click the **Generate token** button.
16+
17+
After you have created the token, you will end up back at the *Personal access tokens* page.
18+
**Copy the alphanumeric token** that is highlighted in green.
19+
20+
Save your GitHub username and PAT to a new file called ``~/.config/bloom``, with the format below:
21+
22+
.. code-block:: text
23+
24+
{
25+
"github_user": "<your-github-username>",
26+
"oauth_token": "<token-you-created-for-bloom>"
27+
}

0 commit comments

Comments
 (0)