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.

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

Fixed documentation code for deployment in Github Action #1523

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hbina
Copy link

@hbina hbina commented Jun 10, 2021

It seems like you need to append with your username to access the secret token.
See: https://githubmemory.com/repo/shalzz/zola-deploy-action/issues/13

Signed-off-by: Hanif Bin Ariffin hanif.ariffin.4326@gmail.com

IMPORTANT: Please do not create a Pull Request adding a new feature without discussing it first.

The place to discuss new features is the forum: https://zola.discourse.group/
If you want to add a new feature, please open a thread there first in the feature requests section.

Sanity check:

  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Code changes

(Delete or ignore this section for documentation changes)

  • Are you doing the PR on the next branch?

If the change is a new feature or adding to/changing an existing one:

  • Have you created/updated the relevant documentation page(s)?

It seems like you need to append with your username to access the secret token.
See: https://githubmemory.com/repo/shalzz/zola-deploy-action/issues/13

Signed-off-by: Hanif Bin Ariffin <hanif.ariffin.4326@gmail.com>
@hbina hbina changed the title Fixed deployment in Github Action Fixed documentation code for deployment in Github Action Jun 10, 2021
@Keats
Copy link
Collaborator

Keats commented Jun 10, 2021

I am not sure if it's the right fix since you might use a token that is not bound to the actor?

Edit: imagine publishing the docs for zola which is in an org with many people editing the docs

@hbina
Copy link
Author

hbina commented Jun 10, 2021

Hmm, I don't know enough about how any of this work so I'll leave it up to you.

@Keats
Copy link
Collaborator

Keats commented Sep 3, 2021

I think we should probably remove that documentation and just point to the action repo. Otherwise it can get out of sync easily.

@prrao87
Copy link

prrao87 commented Dec 8, 2023

I think this particular page is causing a lot of confusion to the community -- I agree with @Keats that the documentation should just point to the action repo. It's already out of sync and I had to resolve a host of issues in deploying my first Zola blog recently because it's misleading and the provided action in the Zola docs didn't work for me.

There are a host of issues related to gh-pages even here in this repo because some people (but not others) are facing weird issues similar to the one I documented here:
shalzz/zola-deploy-action#81

The action author has published a hotfix that addresses this issue for some users and released v0.17.2-1 that seems to do the job. As such, it makes sense to close this PR and clean up the documentation to just point to the action repo to reduce the maintenance burden on this end.

Happy to send a PR here if this works.

@Keats
Copy link
Collaborator

Keats commented Dec 8, 2023

Yeah, go for it. New version of Zola is going to be released either this weekend (unlikely due to RL) or next week, I had a look through the open bugs yesterday.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants