Skip to content

Update contributeactiondev.rst #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pradeeban merged 2 commits into from
Jul 1, 2023
Merged

Update contributeactiondev.rst #19

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae56651
Update contributeactiondev.rst
parteekcoder Jun 30, 2023
5581b00
Update contributeactiondev.rst
parteekcoder Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/source/contributeactiondev.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -54,17 +54,17 @@ 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/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
---------------------------

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

Expand All @@ -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``
- 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``