Trigger docs build on folder changes by mrcasals · Pull Request #7360 · decidim/decidim

mrcasals · 2021-02-12T14:04:01Z

🎩 What? Why?

This PR adds a workflow to trigger a build on https://github.com/decidim/documentation/ every time there are changes in the docs folder here. This should only be triggered in the main branch.

The workflow was successfully triggered by 0092e09, which created decidim/documentation@3e11e45 on the documentation repo.

📌 Related Issues

decidim/documentation#43

Testing

Nothing.

This should trigger a build on decidim/documentation.

mrcasals · 2021-02-12T14:25:13Z

.github/workflows/on_docs_update.yml

+    - name: Send dispatch for trigger_build workflow
+      run: |
+        curl --request POST \
+        --user "decidim-bot:${{ secrets.DOCKER_WORKFLOW_PAT }}" \


@oliverbarnes hi! I'm trying to trigger a workflow from this repo to decidim/documentation, but I suspect I'm sending something wrong. Specially in this line, should I create a new PAT for the decidim-bot user? Can you give me a help with that?

Thanks!

Sorry, I missed the notification for this message somehow :/ That's right, decidim-bot needs a PAT saved as a secret (DOCS_GEN_WORKFLOW perhaps?) on decidim/documentation. And it also needs to be have access to the repo - I've gone ahead and given it just now.

I don't have decidim-bot's credentials in order to generate its PAT, though. @andreslucena does

BTW, Andrés - I think you might have created the original DOCKER_WORKFLOW_PAT under your own user, since decidim-bot doesn't have access to decidim/docker, and the workflow dispatch still works with it 🤔 😄

decidim-bot needs a PAT saved as a secret

I've created and send it privately to @mrcasals

on decidim/documentation.

PATs belong to the user AFAIK

I've gone ahead and given it just now.

I've removed and added it to the group that belongs (developers) as it's easier to manage groups vs users (at least for me) --- maybe with decidim-bot as it's special it'd be better to have it configured to the repostiories that it need access?

BTW, Andrés - I think you might have created the original DOCKER_WORKFLOW_PAT under your own user, since decidim-bot doesn't have access to decidim/docker, and the workflow dispatch still works with it thinking smile

PAT belongs to the user settings account https://github.com/settings/tokens - in the decidim-bot account we have these:

Documentation generator action

Crowdin Decidim.org

Container Registry

Docker Workflow

Crowdin

decidim-bot belongs to developers group: https://github.com/orgs/decidim/teams/developers/members
developers group has read access to docker repository: https://github.com/orgs/decidim/teams/developers/repositories
I think with read access should work in this case also, as I'm seeing that with that:

Can read and clone this repository. Can also open and comment on issues and pull requests.

Maybe it don't need read access and just with the PAT is enough, as we're always working with public repositories, but I'm not sure.

Yes, Personal Access Token belongs to a user :) and that user needs to have access to the repo for a secret created with their PAT to work. If decidim-bot is now part of a group with global access to the Decidim repos, its PAT should work wherever it's added as a secret now. Agree it makes more sense to manage it in a group. Not sure that should be developers or maintainers though - I think it needs more than read access.

My asking about whether you created the PAT under your own personal account came from not seeing decidim-bot inside any of the decidim/docker groups or users, but still the DOCKER_WORKFLOW_PAT seemed to be working there. Only way I could see for that to be the case would be for it to have been created under your own user.

I think it needs more than read access

You're right!! I thought that with read access was enough but there was an error saying that it needs admin rights... So we're back to were we where (with decidim-bot with admin rights in the repo 😅)

My asking about whether you created the PAT under your own personal account came from not seeing decidim-bot inside any of the decidim/docker groups or users, but still the DOCKER_WORKFLOW_PAT seemed to be working there. Only way I could see for that to be the case would be for it to have been created under your own user.

Yes, that's weird actually.... I think it could be because packages permissions aren't in the repository, only in the organization or something like that: the PAT has permissions to write: packages but we don't configure this rule of allowing the package <-> repository write and publish to this user/group nowhere 🤷🏽

Ahh, that could be. The registry is indeed its own thing at the org level

mrcasals · 2021-02-12T14:25:25Z

.github/workflows/on_docs_update.yml

+  trigger_docker_build:
+    name: Trigger decidim/documentation build
+    runs-on: ubuntu-latest
+    if: "github.ref == 'refs/heads/chore/trigger-docs-build'"


Change this before merging!

mrcasals · 2021-02-23T10:36:15Z

@oliverbarnes I keep getting this message:

Any idea what's going on? @andreslucena says @decidim-bot is an admin in the documentation repo :(

oliverbarnes · 2021-02-23T11:48:38Z

Any idea what's going on? @andreslucena says @decidim-bot is an admin in the documentation repo :(

I do see it with admin rights there 🤔 I'm wondering if the PAT has enough permissions - does it have the same permissions as the PAT for DOCKER_WORKFLOW_PAT, @andreslucena?

I suggest giving @mrcasals access to decidim-bot creds, since he's a maintainer, so he can tweak its PATs permissions. It'll be a lot quicker this way

oliverbarnes · 2021-02-24T10:49:46Z

Looking at the builds just now, the dispatch seems to be sent successfully? https://github.com/decidim/decidim/actions/workflows/on_docs_update.yml

mrcasals · 2021-02-25T10:34:52Z

@oliverbarnes nope, the logs say otherwise:

Also, there's no new commit in the master branch of the deocumentation repo!

oliverbarnes · 2021-02-25T10:59:10Z

My bad, didn't expand the log entry nor check for a new commit.

It'd be better if the step would fail in these cases, though.

I'm off today and tomorrow morning, but will look into how to make it exit in this scenario when I'm back

andreslucena · 2021-02-26T08:59:01Z

I do see it with admin rights there thinking I'm wondering if the PAT has enough permissions - does it have the same permissions as the PAT for DOCKER_WORKFLOW_PAT, @andreslucena?

I've reviewed it... You were right as usual 😉 - It didn't have the permissions, I've fixed that

I suggest giving @mrcasals access to decidim-bot creds, since he's a maintainer, so he can tweak its PATs permissions. It'll be a lot quicker this way

I sent them to @mrcasals so I'm not a bottleneck for these tries

mrcasals · 2021-02-26T10:26:59Z

@andreslucena @oliverbarnes it looks like after the latest changes, the workflow is working fine! Here's the commit that was created after the workflow triggered by the commit 0092e09 in this branch:

decidim/documentation@3e11e45

Yay!!

This reverts commit 65be0a1.

oliverbarnes · 2021-02-26T12:06:03Z

🎉 awesome! And next time we need to setup a workflow like this, it should be easier

* develop: (25 commits) Add css selectors to emails to improve design customization (#7493) Only share tokens if component exists (#7499) Fix record encryptor hash values JSON parsing for legacy unencrypted hash values (#7494) Fix NULL error with weight field in assemblies & processes (#7486) Fix proposals to budget import (#7449) Fix cost display on proposals (#7450) Fix #7487 - Invalid signature on message decryption (#7488) New Crowdin updates (#7482) Move specs file to correct folder (#7476) Improve changelog generator (#7475) New Crowdin updates (#7472) Prepare 0.25-dev version (#7473) New Crowdin updates (#7470) New Crowdin updates (#7468) Feature proposal infinite edit time (#7406) New Crowdin updates (#7457) Trigger docs build on folder changes (#7360) Add changelog generator based on PR data (#7461) Add Votings to Open Data export (#7388) Add order in not highlighted assemblies by weight (#7444) ...

mrcasals added target: developer-experience team: documentation labels Feb 12, 2021

mrcasals added 2 commits February 12, 2021 15:05

Trigger docs build on folder changes

774aed7

Fix docs formatting

0501ef5

This should trigger a build on decidim/documentation.

mrcasals force-pushed the chore/trigger-docs-build branch from b7e7f2b to 0501ef5 Compare February 12, 2021 14:08

mrcasals commented Feb 12, 2021

View reviewed changes

mrcasals added 6 commits February 23, 2021 11:09

Use correct secret key

7a56174

Empty commit

8e1d94a

Temporarily remove CI tests

65be0a1

Update docs

58ab667

Fix docs

526cd55

Fix docs

bdb7ab9

Update docs

0092e09

mrcasals added 3 commits February 26, 2021 11:27

Remove dash

c9bb1e6

Revert "Temporarily remove CI tests"

fd8d010

This reverts commit 65be0a1.

Fix branch reference to use the default one

e93e441

mrcasals merged commit e1ce425 into develop Feb 26, 2021

mrcasals deleted the chore/trigger-docs-build branch February 26, 2021 13:11

oliverbarnes mentioned this pull request Mar 2, 2021

Exit on CI workflow dispatch failures #7502

Merged

12 tasks

Uh oh!

Conversation

mrcasals commented Feb 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎩 What? Why?

📌 Related Issues

Testing

Uh oh!

mrcasals Feb 12, 2021

Choose a reason for hiding this comment

Uh oh!

oliverbarnes Feb 18, 2021

Choose a reason for hiding this comment

Uh oh!

andreslucena Feb 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oliverbarnes Feb 23, 2021

Choose a reason for hiding this comment

Uh oh!

andreslucena Feb 24, 2021

Choose a reason for hiding this comment

Uh oh!

oliverbarnes Feb 24, 2021

Choose a reason for hiding this comment

Uh oh!

mrcasals Feb 12, 2021

Choose a reason for hiding this comment

Uh oh!

mrcasals commented Feb 23, 2021

Uh oh!

oliverbarnes commented Feb 23, 2021

Uh oh!

oliverbarnes commented Feb 24, 2021

Uh oh!

mrcasals commented Feb 25, 2021

Uh oh!

oliverbarnes commented Feb 25, 2021

Uh oh!

andreslucena commented Feb 26, 2021

Uh oh!

mrcasals commented Feb 26, 2021

Uh oh!

oliverbarnes commented Feb 26, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mrcasals commented Feb 12, 2021 •

edited

Loading

andreslucena Feb 23, 2021 •

edited

Loading