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

Jump to bottom

Fix docs deployment #1867

Closed
wjones127 opened this issue Nov 15, 2023 · 2 comments
Closed

Fix docs deployment #1867

wjones127 opened this issue Nov 15, 2023 · 2 comments
Assignees
@r3stl355
Labels
documentation Improvements or additions to documentation

Comments

@wjones127
Copy link
Collaborator

wjones127 commented Nov 15, 2023 •
edited
Loading

Description

https://github.com/delta-io/delta-rs/actions/runs/6880582444/job/18715123279

Likely a matter of which credentials the job is running under.

Use Case

Related Issue(s)
@wjones127 wjones127 added the documentation Improvements or additions to documentation label Nov 15, 2023
@r3stl355
Copy link
Contributor

I need to do some experiments with this.

@wjones127 do you have write access to gh-pages branch? (I presume you do).

The failing action is https://github.com/JamesIves/github-pages-deploy-action, responsible for deploying the build results to a gh-pages branch. According to the action's docs, you must ... provide Read and Write Permissions to the provided GITHUB_TOKEN but I am not sure which GITHUB_TOKEN was used when the action was triggered manually.
Previous deployment scripts used github.GITHUB_TOKEN to do the same.

The action has a token property which I can try setting to github.GITHUB_TOKEN but I am not sure it will make any difference as it seems to be a default value.

The other alternative is to add permissions: contents: write to the action - that should work but will result in a longer script as I'd have create a separate step for deployment.

Lastly, during the release process docs release is run as a dispatched/async job so even if it fails, the main release should not be effected.

@r3stl355
Copy link
Contributor

take

@r3stl355 r3stl355 mentioned this issue Nov 16, 2023
Merged
wjones127 added a commit that referenced this issue Nov 17, 2023
@r3stl355 @wjones127
fix: docs deployment action (#1869)
44a3760 
# Description
Moved the requirement for contents write permission from release action
to docs deployment. The same permission was used in the previous release
action (sphinx) so I'm not introducing any extra permission
requirements.

One thing I don't really like here is that such permission is only
needed for the `Deploy` step but the lowest level it can be defined is
job. This should be fine because other steps in the job don't do any git
operations.

Alternative would be creating a separate Deploy job but then I'd have to
duplicate all the steps from the Build part which would effectively be
the same thing as now but with a longer/redundant config.

Deployment logic remains the same - docs are deployed only when the
Build Documentation is run manually or via the Release Python action.

# Related Issue(s)
 #1867

I am unable to fully test this in my environment because the failing
version was actually working in my repo - I don't see how things are
configured in the main repo.

Signed-off-by: Nikolay Ulmasov <[email protected]>
Co-authored-by: Will Jones <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@r3stl355 r3stl355

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@wjones127 @r3stl355 @ion-elgreco