GitHub actions for newsite branch #46

Shekharrajak · 2019-10-02T06:27:12Z

Github action : deploy-action created.
Github workflow "deploy" job will trigger the deploy-action
The pattern of the URL is : pr-<pr_number>-numpy.org-newsite.surge.sh

So for this PR it is : http://pr-46-numpy.org-newsite.surge.sh

Advantages:

Now reviewing the UI changes easy because no need to clone the branch and check the UI locally. It can be seen in the deployed URL.
PR author doesn't have to create GIF or attach screenshot for the UI changes. Dynamic changes can be seen easily in the URL.
Every PR will be having the deployed URL so we can see the transformation of the website easily.

Shekharrajak · 2019-10-03T15:10:00Z

Tried to get PR number using : export PR_NUMBER="$(echo ${{REF}} | cut -d'/' -f3)"

and IFS='/' read -r -a array <<< "$REF"

joelachance · 2019-10-03T15:12:27Z

.github/workflows/main.yml

+          - ubuntu-latest
+          - windows-latest
+    steps:
+      - uses: actions/checkout@master


do we want to specify the newsite branch for this? Obviously it will need to be master when we merge all the changes.

~~Yes, that has to be changed when we merge newsite branch to master.~~

+1 for changing it to actions/checkout@newsite now

As far as I understand, checkout action need the tag of the repository not the branch. So it is basically action/checkout@<tags> .I tried with newsite and got this error in log: https://github.com/numpy/numpy.org/pull/46/checks?check_run_id=249019844

My understanding is that the @ symbol used in an action specifies the version of the action: https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepsuses

Thanks @WarrenWeckesser for the link. I am wondering why it is working with this@master and the base branch for the PR is newsite. Here I see that we can use specific branch using

- uses: actions/checkout@master with: ref: some-branch

I'm still figuring this out, so all I can say is that uses: actions/checkout@master means you are, in effect, using the development version of the checkout action, i.e. the masterbranch of https://github.com/actions/checkout

Yeah! It looks like you are correct. Since it is in this format {owner}/{repo}/{path}@{ref}. and using with option we are customizing the branch, sha, release version.

So I think basically it is using this PR branch and latest commit to run the action specified.

It looks like the default branch (or SHA) that is checked out is explained in https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events. In particular, see the GITHUB_SHA column of the tables for pull_request and push events.

Also, README.md for the checkout action says

By default, the branch or tag ref that triggered the workflow will be checked out. If you wish to check out a different branch, specify that using with.ref

joelachance · 2019-10-03T15:12:41Z

.github/workflows/main.yml

+        python-version:
+          - 3.7
+    steps:
+      - uses: actions/checkout@master


Same question here.

joelachance · 2019-10-03T15:16:44Z

Dockerfile

@@ -0,0 +1,16 @@
+FROM node:10-alpine


Do we need node alpine? We might be able to use another image (something smaller, if it exists), although it probably doesn't really matter :)

node docker image is used because later in deploy script it is installing the surge package.

It maybe doesn't matter here, but Alpine is one of the most problematic distributions for Python packages, because it's musl rather than glibc based so manylinux wheels don't work if they contain compiled code. Just FYI

Thanks for the info.

joelachance · 2019-10-03T15:17:12Z

Looks good so far!

Shekharrajak · 2019-10-03T15:22:52Z

Currently, I am getting issue in assigning variable values and in setting env variable inside of the docker container after extracting the PR number from the $github.ref env variable.

I will clean the commits.

main.yml minor change main.yml minor change

moved

…ctions

moved

minor change minor change

minor change

minor change in main.yml deploy.sh set the output name minor change - dockerfile to get var value minor change - dockerfile to get var value

Shekharrajak · 2019-10-03T16:03:22Z

Finally more than 50 try, it worked and it is able to extract the PR number from the github.ref variable inside the docker container (while running the bin/sh script).

It is getting deployed in http://pr-46-numpy.org-newsite.surge.sh

Shekharrajak

We can remove the test job or improve it to make it work similar to travis test job.

Shekharrajak · 2019-10-05T08:56:38Z

.github/workflows/main.yml

+        env:
+          REF: ${{ github.ref}}
+        run: |
+          echo Checking github env variables:


This has to be removed and proper test should run (similar to the travis CI/CD)

We don't really have tests. Maybe it can be checked that the Hugo build finishes without errors or warnings?

I have removed this job for now. We can add jobs later as per the requirements.

Shekharrajak · 2019-10-05T08:57:18Z

.github/workflows/main.yml

+          SURGE_LOGIN: ${{ secrets.SURGE_LOGIN}}
+          REF: ${{ github.ref}}
+      - name: Get the output time
+        run: echo "The output was ${{ steps.deploy.outputs.deployed-domain }}"


This can be removed later. This is just to check the deployed-domain URL.

Shekharrajak · 2019-10-05T08:58:56Z

@joelachance @rgommers please review. If it is looking good then we can merge this branch to newsite for now.

rgommers · 2019-10-05T12:45:17Z

This looks pretty clean to me, happy to see it merged.

One question about the Surge setup: is this PR all that is needed, or do we need to have some account with access credentials that need storing somewhere?

Shekharrajak · 2019-10-05T13:37:10Z

This looks pretty clean to me, happy to see it merged.

One question about the Surge setup: is this PR all that is needed, or do we need to have some account with access credentials that need storing somewhere?

Thanks for the review. To deploy the static contents we need to have SURGE_LOGIN and SURGE_TOKEN as environment variable. In github action we can add environment variables secretly in settings->secret tab. I have added my surge token and login mail ID. It can be changed in the future and it will not affect anything.

joelachance · 2019-10-05T15:29:53Z

Looks good! Feel free to merge.

Shekharrajak added 11 commits October 2, 2019 11:31

gitignore added

2af4bcd

grunt dependencies added in package.json

82d2b21

remove package.json

590fd00

github actions main.yml initially

74e4a12

build the hugo project script added

e073a72

deploy the hugo project script added

9a0c948

install the hugo in docker container script added

ddd3647

Dockerfile to run install, build, deploy scripts

a524608

Docker service uses

45158ce

.github action - deploy action added and main.yml is using the action

831b49d

deploy.sh is using the first arg

7af6ac2

joelachance reviewed Oct 3, 2019

View reviewed changes

.github/workflows/main.yml

python-version:

- 3.7

steps:

- uses: actions/checkout@master

Copy link

Collaborator

joelachance Oct 3, 2019

Choose a reason for hiding this comment

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

Same question here.

joelachance reviewed Oct 3, 2019

View reviewed changes

Shekharrajak force-pushed the githubActions branch 2 times, most recently from eebf090 to 4553541 Compare October 3, 2019 15:28

Shekharrajak added 7 commits October 3, 2019 21:11

main.yml updated - run option not needed for the defined actions

b38d9d4

main.yml minor change main.yml minor change

action.yml should be in folder

b487dba

moved

OS - ubuntu - docker container is only supported in linux in github a…

b5a7ccb

…ctions

dockerfile should be in action folder

676cf65

moved

relative dockerfile path

d48c5ae

minor change minor change

copy hugo project

5477185

minor change

move back to root directory

61ea985

minor change in main.yml deploy.sh set the output name minor change - dockerfile to get var value minor change - dockerfile to get var value

Shekharrajak force-pushed the githubActions branch from 4cd257f to c3059ba Compare October 3, 2019 15:43

deploy.sh get the PR number from the REF env using cut pipe

13dd632

Shekharrajak force-pushed the githubActions branch from d9d77ce to 13dd632 Compare October 3, 2019 16:00

Shekharrajak commented Oct 5, 2019

View reviewed changes

remove the Test job and minor changes

0e57ed8

master checkout uses the branch code

3c1de08

Shekharrajak mentioned this pull request Oct 5, 2019

Confused with checkout@master when base branch is not master actions/checkout#52

Closed

Shekharrajak merged commit 84048be into newsite Oct 6, 2019

Shekharrajak mentioned this pull request Oct 17, 2019

[GSoD] Redesigning and restructuring of NumPy documentation numpy/numpy#14473

Closed

8 tasks

rgommers deleted the githubActions branch October 17, 2019 11:55

This was referenced Oct 20, 2019

Testing - Surge deploy #58

Merged

Deployment #39

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub actions for newsite branch #46

GitHub actions for newsite branch #46

Shekharrajak commented Oct 2, 2019 •

edited

Shekharrajak commented Oct 3, 2019

joelachance Oct 3, 2019

Shekharrajak Oct 3, 2019 •

edited

rgommers Oct 5, 2019

Shekharrajak Oct 5, 2019

WarrenWeckesser Oct 5, 2019 •

edited

Shekharrajak Oct 5, 2019

WarrenWeckesser Oct 5, 2019

Shekharrajak Oct 5, 2019

WarrenWeckesser Oct 5, 2019

joelachance Oct 3, 2019

joelachance Oct 3, 2019

Shekharrajak Oct 3, 2019

rgommers Oct 5, 2019

Shekharrajak Oct 5, 2019

joelachance commented Oct 3, 2019

Shekharrajak commented Oct 3, 2019

Shekharrajak commented Oct 3, 2019 •

edited

Shekharrajak left a comment

Shekharrajak Oct 5, 2019

rgommers Oct 5, 2019

Shekharrajak Oct 5, 2019

Shekharrajak Oct 5, 2019

Shekharrajak commented Oct 5, 2019

rgommers commented Oct 5, 2019

Shekharrajak commented Oct 5, 2019

joelachance commented Oct 5, 2019

GitHub actions for newsite branch #46

GitHub actions for newsite branch #46

Conversation

Shekharrajak commented Oct 2, 2019 • edited

Shekharrajak commented Oct 3, 2019

Choose a reason for hiding this comment

Shekharrajak Oct 3, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WarrenWeckesser Oct 5, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joelachance commented Oct 3, 2019

Shekharrajak commented Oct 3, 2019

Shekharrajak commented Oct 3, 2019 • edited

Shekharrajak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shekharrajak commented Oct 5, 2019

rgommers commented Oct 5, 2019

Shekharrajak commented Oct 5, 2019

joelachance commented Oct 5, 2019

Shekharrajak commented Oct 2, 2019 •

edited

Shekharrajak Oct 3, 2019 •

edited

WarrenWeckesser Oct 5, 2019 •

edited

Shekharrajak commented Oct 3, 2019 •

edited