Skip to content

Conversation

@madolson
Copy link
Member

Description

Allows someone with sufficient permissions to deploy the website by issuing a dispatch event to this repository. This is needed to allow other repository pushes to update the website.

Issues Resolved

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.

Signed-off-by: Madelyn Olson <[email protected]>
Signed-off-by: Madelyn Olson <[email protected]>
@madolson madolson merged commit f93e979 into main Feb 27, 2025
1 check passed
@madolson madolson deleted the main-test branch February 27, 2025 17:04
madolson added a commit to valkey-io/valkey-doc that referenced this pull request Feb 27, 2025
…239)

This will allow the website to automatically get updated when we update
the doc repository. I setup a repository action on the website github,
which allows incoming events to trigger the build and deploy action.

Some notes about security. The credential being used has write
permission the website repository, so to compensate I locked down all
the branches to require PRs, which should prevent any malicious
attackers if they get access to the credentials. The downside is no more
directly pushing to the website, which I think is an OK tradeoff.

This PR is dependent on this PR getting merged first:
valkey-io/valkey-io.github.io#214.


Some other things I investigated:
1. [Re-usable
workflows](https://docs.github.com/en/actions/sharing-automations/reusing-workflows):
I wasn't able to get the deploy functionality to have permissions across
repository, these seem to only work correctly within the same
repository.
2. Triggering the website build from this repo. This required
duplicating the build and deploy steps. This seemed like a cleaner
approach.

Signed-off-by: Madelyn Olson <[email protected]>
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.

3 participants