From ae566510c4f535e58e7bb1a533951d42fd19ba66 Mon Sep 17 00:00:00 2001 From: Parteek Goyal Date: Fri, 30 Jun 2023 23:17:33 +0530 Subject: [PATCH 1/2] Update contributeactiondev.rst --- docs/source/contributeactiondev.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/source/contributeactiondev.rst b/docs/source/contributeactiondev.rst index e439b0b..e7df86e 100644 --- a/docs/source/contributeactiondev.rst +++ b/docs/source/contributeactiondev.rst @@ -37,7 +37,7 @@ Creating token for bot This token is used to create branches and push studies to bot repo.After pushing studies to bot repo it dispatch ``pull_request.yml`` workflow. -- Open the bot account at github and navigate as follow: +- Open the ControlCore-Project account at github and navigate as follow: settings > Developer settings > Personal access token > Fine-grained access token > Generate New token @@ -56,7 +56,7 @@ This token is used to create branches and push studies to bot repo.After pushing - Then copy the generated token and hash it using this website in base64 encoding http://www.unit-conversion.info/texttools/base64/ -- Place the token in ``contribute.py`` script at https://github.com/parteekcoder/concore/blob/main/contribute.py#L7 +- Place the token in ``contribute.py`` script at https://github.com/ControlCore-Project/concore/blob/dev/contribute.py#L7 Creating token for workflow @@ -64,7 +64,7 @@ Creating token for workflow This token is used to create pull request to upstream repo using bot account as author of pull request. -- Open bot account at Github +- Open ControlCore-Project account at Github - Create a Personal access token of bot account at https://github.com/settings/tokens/new @@ -78,9 +78,12 @@ This token is used to create pull request to upstream repo using bot account as .. image:: images/ca-workflow-token-generate.png :width: 700 -- Add this token as Github secret in bot repo at https://github.com/parteekcoder123/concore-studies/settings/secrets/actions/new with name ``token`` +- Add this token as Github secret in bot repo at https://github.com/ControlCore-Project/concore-studies-staging/settings/secrets/actions/new with name ``token`` .. image:: images/ca-workflow-secret.png :width: 700 -- Click ``Add secret`` \ No newline at end of file +- Click ``Add secret`` + + +``Optional:- If you want to explore why we came up with this approach , please refer https://docs.google.com/document/d/1DdmPO51qOb9OQoiQ4RMH-3O80gxrGWJuHc9QV_AlW0U/edit?usp=sharing`` \ No newline at end of file From 5581b0095aa764b5755cb8765ab80d07c36ef8ae Mon Sep 17 00:00:00 2001 From: Parteek Goyal Date: Fri, 30 Jun 2023 23:21:34 +0530 Subject: [PATCH 2/2] Update contributeactiondev.rst --- docs/source/contributeactiondev.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contributeactiondev.rst b/docs/source/contributeactiondev.rst index e7df86e..1f63ade 100644 --- a/docs/source/contributeactiondev.rst +++ b/docs/source/contributeactiondev.rst @@ -54,7 +54,7 @@ This token is used to create branches and push studies to bot repo.After pushing - Click **Generate token** button -- Then copy the generated token and hash it using this website in base64 encoding http://www.unit-conversion.info/texttools/base64/ +- Then copy the generated token and hash it using this website in base64 encoding http://www.unit-conversion.info/texttools/base64/ . Note this hashing is important as Github automatically revoke any token present in the code. - Place the token in ``contribute.py`` script at https://github.com/ControlCore-Project/concore/blob/dev/contribute.py#L7