feat: deploy to other repo (#35)

[skyfrk]

⚠ I didn't test this yet!

This PR addresses #35 .

• I added a new environment variable PUBLISH_REPO (format: <username>/<repo>) which is used to build the remote_repo strings.
• If PUBLISH_REPO is not set it will be set and initialized with GITHUB_REPOSITORY.
• If PUBLISH_REPO is different from GITHUB_REPOSITORY and GITHUB_TOKEN is used an error message will be printed and the script exits (the GITHUB_TOKEN is scoped to the repository which runs the action).

Example how this can be used:

- name: Deploy
  uses: peaceiris/[email protected]
  env:
    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    PUBLISH_REPO: peaceiris/peaceiris.github.io
    PUBLISH_BRANCH: master
    PUBLISH_DIR: ./public

Any feedback is welcome 😊

[peaceiris]

Thank you. I will add some changes.

[peaceiris]

@skyfrk You can test now.

I could deploy with PERSONAL_TOKEN

• https://github.com/peaceiris/hugo-test-project/runs/238365373
• https://github.com/peaceiris/test-hugo-external-repo

    - name: Deploy
      uses: peaceiris/actions-gh-pages@feature/deploy_to_other_repo
      env:
        # ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
        PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
        PUBLISH_BRANCH: gh-pages
        PUBLISH_DIR: ./public
        EXTERNAL_REPOSITORY: peaceiris/test-hugo-external-repo

[peaceiris]

Test with ACTIONS_DEPLOY_KEY succeeded.

• https://github.com/peaceiris/hugo-test-project/runs/238378099#step:6:27

[peaceiris]

We can test with v2.5.0-rc0 now.

Test with the docker image from Docker Hub succeeded.

• https://github.com/peaceiris/hugo-test-project/runs/238391592#step:6:25

[peaceiris]

LGTM.
@skyfrk Do we need any other changes?

[peaceiris]

Oh, internal deployment failed. Why?

[peaceiris]

Test on my private repo with docker://peaceiris/gh-pages:v2.5.0-rc0 succeeded. peaceiris/hugo-test-project has some problems. I cannot figure it out.

We need more tests with docker://peaceiris/gh-pages:v2.5.0-rc0 and peaceiris/[email protected] for existing workflows.

[skyfrk]

My tests using

    - name: Deploy to GitHub Pages
      uses: peaceiris/actions-gh-pages@feature/deploy_to_other_repo
      env:
        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
        PUBLISH_BRANCH: master
        PUBLISH_DIR: ./public
        EXTERNAL_REPOSITORY: skyfrk/skyfrk.github.io

and

    - name: Deploy to GitHub Pages
      uses: peaceiris/[email protected]
      env:
        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
        PUBLISH_BRANCH: master
        PUBLISH_DIR: ./public
        EXTERNAL_REPOSITORY: skyfrk/skyfrk.github.io

were successfull! 😄

Could you eloborate on the problems you're facing?

[peaceiris]

See this log https://github.com/peaceiris/hugo-test-project/commits/gh-pages

GitHub Pages build event did not start with v2.5.0-rc0 for internal deployment. External is OK.

[skyfrk]

Looks like a GitHub Action bug to me. Can you try to trigger an internal deployment again?

[peaceiris]

The internal deployment failed again.

    - name: Deploy
      uses: peaceiris/[email protected]
      env:
        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
        PUBLISH_BRANCH: gh-pages
        PUBLISH_DIR: ./public

[skyfrk]

I don't get it. The gh-pages branch is up to date but not deployed to GH Pages?

[peaceiris]

• Failed: https://github.com/peaceiris/hugo-test-project/commits/gh-pages
• Failed: https://github.com/peaceiris/gatsby-test/commits/gh-pages
• OK: https://github.com/peaceiris/nextjs-test/commits/gh-pages
• OK: my private repo 1
• OK: my private repo 2 (pull from docker hub)

---

(Oct 1)

• gatsby-test looks good.
• hugo-test-project still sometimes failed.

[philomath213]

hey I test v2.5.0-rc0 with to deploy Hugo web site internally and it's working fine
check the test repository for more details,
https://github.com/philomath213/hugo-ci-test

[peaceiris]

Thank you so much @philomath213
Yes, your deployment looks good.

[peaceiris]

After more testing, I will relase v2.5.0. Thank you.