Skip to content
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.

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

Added development setup instructions to README.md #2

Merged
merged 11 commits into from
Jun 17, 2022

Conversation

trz42
Copy link
Contributor

@trz42 trz42 commented May 15, 2022

Detailed instructions on how to set up the development instructions for the EESSI bot for the software layer.

@trz42
Copy link
Contributor Author

trz42 commented May 16, 2022

Add a note on how to use the development version of PyGHee?

@trz42
Copy link
Contributor Author

trz42 commented May 31, 2022

Add a note on how to setup a common scripts dir (from software-layer and eessi-bot-software-layer).

@boegel boegel changed the title (WIP) added development set tup instructions to README.md (WIP) added development setup instructions to README.md Jun 1, 2022
@trz42
Copy link
Contributor Author

trz42 commented Jun 3, 2022

Commit 81c64e6 addresses #2 (comment)

The scripts directory contains scripts from the software-layer repo and
the eessi-bot-software-layer repo. The update also mentions that you
have to provide information to the location of the scripts directory via
the `app.cfg` config file.
@trz42
Copy link
Contributor Author

trz42 commented Jun 3, 2022

Commit 4e8231a addresses #2 (comment)

Added a section that applies to after
EESSI#10 has been
merged.

On the Linux machine set the environment variable `GITHUB_TOKEN`, e.g.
```
export GITHUB_TOKEN='THE_TOKEN_STRING'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually something we shouldn't need at all.
If the bot has a private key, it can request temporary tokens by itself...

This is probably something we should open an issue for in the PyGHee repo, since that's where the requirement for $GITHUB_TOKEN comes from currently.
PyGHee should be enhanced to also support providing the location of a private key, and only fall back to requiring $GITHUB_TOKEN if no private key is provided...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created issue boegel/PyGHee#5

truib and others added 3 commits June 16, 2022 18:29
- fixed specification for private key (just in app.cfg needed, no
environment variable)
- rewrote sections on getting repo for bot and creating app.cfg from
example
First we need to install the github app (now step 3). Then we can add
the `installation_id` to the bot's configuration file `app.cfg`.
@trz42 trz42 changed the title (WIP) added development setup instructions to README.md Added development setup instructions to README.md Jun 16, 2022
@trz42 trz42 requested a review from boegel June 16, 2022 18:54
Copy link
Contributor

@bedroge bedroge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, huge improvement over the old page. There's still some work to be done later on, e.g. clarifying the stuff with private keys and/or tokens, but that can be done in separate PRs once this has been changed in PyGHee.

@bedroge bedroge merged commit 61023b6 into EESSI:main Jun 17, 2022
@boegel boegel added the docs Improvements or additions to documentation label Nov 3, 2022
@trz42 trz42 deleted the dev-env-instructions branch February 24, 2023 19:51
trz42 pushed a commit that referenced this pull request Aug 7, 2024
trz42 pushed a commit that referenced this pull request Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants