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.

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

Fix license handling #2

Merged
merged 5 commits into from
Aug 29, 2024
Merged

Fix license handling #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
87d03e0
Revert back to previous secret code
ntBre Aug 26, 2024
f93154f
ignore oe_license.txt
ntBre Aug 26, 2024
3ef91ab
update path to organization OE_LICENSE
ntBre Aug 26, 2024
36351d8
remove the license before performing any git operations
ntBre Aug 26, 2024
59c333f
git add only the output csv files instead of .
ntBre Aug 26, 2024
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
10 changes: 8 additions & 2 deletions .github/workflows/run.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,14 @@ jobs:

- name: Run benchmarks
env:
OE_LICENSE: ${{ github.workspace }}/oe_license.txt
LICENSE: ${{ secrets.OE_LICENSE }}
shell: bash -l {0}
run: |
set -e
echo "$LICENSE" > /tmp/oe_license.txt
Copy link
Member

Choose a reason for hiding this comment

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

Just double-checking my understanding, this spits out the license to file but it's encrypted, or otherwise not accessible from a third-party attacker?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks for the review! Yeah, at least to my understanding, this writes the license to a plain file, but it should be restricted to our instance of the GitHub runner, although it's not encrypted.

The only difference between this and the yammbs CI is where the secret is stored. In yammbs it's ${{ github.workspace }}/oe_license.txt, which expands to /home/runner/work/yammbs/yammbs/oe_license.txt. I chose /tmp here to keep it out of the repo in case of any errant git add commands. Of course, with the gitignore and removing the license after using it, it should be safer to write it somewhere else if you prefer. $HOME could be another option, if we're worried specifically about /tmp.

Copy link
Member

Choose a reason for hiding this comment

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

Yup all good ideas I think

export OE_LICENSE=/tmp/oe_license.txt
python main.py ${{ inputs.path }} $(nproc)
rm $OE_LICENSE

- name: Commit results
shell: bash -l {0}
Expand All @@ -97,7 +100,10 @@ jobs:
git config --global init.defaultBranch main

# Commit the benchmark results and push
git add .

input_file=${{ inputs.path }} # path to the input YAML file
input_dir=$(dirname $input_file) # parent directory of input YAML file
git add $input_dir/output/{dde,icrmsd,rmsd,tfd}.csv # add only the output CSV files
git commit -m "Add benchmark results"
git push

Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
oe_license.txt