add workflow to deploy updatesite for each master branch change #58

ingomohr · 2020-06-16T23:14:55Z

For now the workflow does the following:

whenever the master branch changes
the updatesite is built
and on the "updatesite" branch (created if necessary) the "updatesite" folder's contents are being replaced w/ the new updatesite build.

I think we can use this for quick master branch dev integration builds.

@AObuchow Let me know what you think. Any feedback is appreciated :)

ingomohr · 2020-06-16T23:24:07Z

.github/workflows/maven.yml

+    - name: Replace Updatesite
+      run: |
+        rm -r updatesite
+        git config --local user.email "tellastory73@gmail.com"


ah, damn - I think, we need another user for your repo ;) - sorry, my bad

No worries :) I imagine the user would have to be my user? (or any committer on this repo?)

You could use this: https://github.com/PyvesB/eclipse-solargraph/blob/086fee601d1b71da94687cad09444e5d44cf0010/.github/workflows/publish.yml#L24

You could use this: https://github.com/PyvesB/eclipse-solargraph/blob/086fee601d1b71da94687cad09444e5d44cf0010/.github/workflows/publish.yml#L24

Thank you @PyvesB, I'll check that.

@PyvesB Even though I meanwhile suggested another approach - I would still like to understand how your solution works.
What I understood was:

You're using the jq tool to read info from a JSON - in this case from the payload

That way you read the user name of the pusher (of the event that triggered the job)

... and the email (of the same)

... and set both as git credentials

Am I right so far?

The thing is I just wasn't able to get it working.
I just received return code 1 on that step.
Since I didn't have a particular error message, I activated step-debugging on my repo.
But that didn't present me w/ an error message, either.

In your repository I didn't see some import of jq.
So... what do I have to do other than simply copy/pasting your two lines into my script?

Ah ok - now I understand your point. Yes, that's true - the "Github Action" as organization should not be "referenced". This was not intended, anyway.

So, @AObuchow what do you think? Do you want the workflow to be changed to have the actual user listed for the updatesite commit?

@PyvesB, @AObuchow github.actoris surely better than "Github Action", but it just resolves to the user name. Also, I don't know (yet) how to get to the mail address.

We could hardcode the repo's owner's name and mail address, but that would also apply to all forks of the repo...

Would appending "@users.noreply.github.com" to the username work? Doesn't GitHub map that back to the user?

Would appending "@users.noreply.github.com" to the username work? Doesn't GitHub map that back to the user?

Hm, good point. I'll try that. Thanks for the hint, @PyvesB.

Works like a charm :) - I'll create a PR for this.

AObuchow · 2020-06-17T02:28:37Z

.github/workflows/maven.yml

+        git add updatesite/
+    - name: Commit new Updatesite
+      run: |
+        git commit -m "deploy new updatesite"


A cool (but totally unnecessary) improvement for a future PR would be to read the pom.xml version and reference it in the commit message, like "deploy new updatesite for 1.0.8". Just thinking outloud :) It might be too annoying/hard for the value it gives.

Yess! 🔥 Very good idea. I‘ll check that. 😊

I would like to discuss this further in its own issue. What do you think, @AObuchow?
This could make sense once we have a build script that adds new versions instead of simply replacing the latest version.

For sure :) Feel free to make an issue for it, if not I'll remember to make one

AObuchow · 2020-06-17T02:29:07Z

.github/workflows/maven.yml

+      with:
+        branch: updatesite
+        force: true
+        github_token: ${{ secrets.GITHUB_TOKEN }}


I imagine I'll have to setup a github token/secret on the repo? :)

Actually, I have no idea (yet) how that Github Push action determines the token. I have 4 tokens in my account, so if that action uses one of them, then: which one?
It was like that old Macintosh promise: „It just works“. 😂
I‘ll check today what token is referenced.

Some documentation here: https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token

Ok, so the quick take-away is that every repo on Github automatically has this token once you enable Github Actions on the repo. It has some limitations, but it certainly does the thing for our small build job.

Awesome glad to hear :)

AObuchow · 2020-06-17T02:32:36Z

This is AWESOME @ingomohr !!! :D
Asides from the minor comments about the username & github token that need a bit of clarification, this seems great to me :)

I also tested out the updatesite and it works. I used:
https://raw.githubusercontent.com/ingomohr/Eclipse-Modern-Dark-Theme/updatesite/updatesite/

AObuchow · 2020-06-17T02:33:46Z

@PyvesB feel free to check this out by the way as we had previously discussed the topic :)

ingomohr · 2020-06-17T20:57:15Z

.github/workflows/maven.yml

+    - name: Replace Updatesite
+      run: |
+        rm -r updatesite
+        git config --local user.name "GitHub Action"


While trying the find a solution why my jq-approach wasn't working, I found a couple of Github actions that by default specify "Github Action" with a no-reply email address for the commits.

For instance: https://github.com/marketplace/actions/configure-git-credentials

I think this is actually a good idea because you can see very easily that the commit is considered to be created by a Github action, not a human being user.

What do you think?

This is what it looks like.

Yes I’m +1 for that for sure (if it’s easy enough to do) :)

Looks awesome :D

AObuchow · 2020-06-17T20:57:40Z

Hey @ingomohr this looks like it’s just about ready for a merge. Would you mind giving me some tips/instructions on what I need to do on my end as the repo owner? Either as a comment here or on twitter DM

ingomohr · 2020-06-17T21:16:51Z

Hey @ingomohr this looks like it’s just about ready for a merge. Would you mind giving me some tips/instructions on what I need to do on my end as the repo owner? Either as a comment here or on twitter DM

From my point of view the only thing to do after the merge of this PR is to activate Github Actions on your repo's Settings -> Actions -> Enable local and third party Actions for this repository.

AObuchow · 2020-06-17T21:25:07Z

Looks good to me @ingomohr :D Amazing work, this will help get new versions deployed much sooner and more easily. Thank you @PyvesB for your input & review :)

ingomohr commented Jun 16, 2020

View reviewed changes

AObuchow reviewed Jun 17, 2020

View reviewed changes

ingomohr force-pushed the master branch 4 times, most recently from dfe3809 to 1f15a7d Compare June 17, 2020 20:49

add workflow to deploy updatesite for each master branch change

e14eaa1

ingomohr force-pushed the master branch from 1f15a7d to e14eaa1 Compare June 17, 2020 20:50

ingomohr commented Jun 17, 2020

View reviewed changes

AObuchow merged commit 7123869 into AObuchow:master Jun 17, 2020

This was referenced Jun 17, 2020

Use GitHub Actions to deploy releases to the project's repository #20

Closed

Add CI to Auto-Deploy Updatesite - even for PRs (for testing) #39

Closed

ingomohr mentioned this pull request Jul 19, 2020

Make updatesite workflow use actual Github actor instead of 'Github Action' #117

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add workflow to deploy updatesite for each master branch change #58

add workflow to deploy updatesite for each master branch change #58

ingomohr commented Jun 16, 2020

ingomohr Jun 16, 2020

AObuchow Jun 17, 2020

PyvesB Jun 17, 2020

ingomohr Jun 17, 2020

ingomohr Jun 17, 2020

ingomohr Jul 18, 2020 •

edited

Loading

ingomohr Jul 19, 2020

PyvesB Jul 19, 2020

ingomohr Jul 19, 2020

ingomohr Jul 19, 2020

AObuchow Jun 17, 2020

ingomohr Jun 17, 2020

ingomohr Jun 17, 2020

AObuchow Jun 17, 2020

AObuchow Jun 17, 2020

ingomohr Jun 17, 2020

PyvesB Jun 17, 2020

ingomohr Jun 17, 2020

AObuchow Jun 17, 2020

AObuchow commented Jun 17, 2020

AObuchow commented Jun 17, 2020

ingomohr Jun 17, 2020

ingomohr Jun 17, 2020

AObuchow Jun 17, 2020

AObuchow Jun 17, 2020

AObuchow commented Jun 17, 2020

ingomohr commented Jun 17, 2020

AObuchow commented Jun 17, 2020

add workflow to deploy updatesite for each master branch change #58

add workflow to deploy updatesite for each master branch change #58

Conversation

ingomohr commented Jun 16, 2020

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

ingomohr Jul 18, 2020 • edited Loading

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

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

AObuchow commented Jun 17, 2020

AObuchow commented Jun 17, 2020

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

AObuchow commented Jun 17, 2020

ingomohr commented Jun 17, 2020

AObuchow commented Jun 17, 2020

ingomohr Jul 18, 2020 •

edited

Loading