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

Task: Set up an environment to push package doc builds #528

Closed
oraNod opened this issue Apr 30, 2024 · 2 comments
Closed

Task: Set up an environment to push package doc builds #528

oraNod opened this issue Apr 30, 2024 · 2 comments
Labels
Epic: RTD migration Work related to migrating community docs hosting to ReadTheDocs task

Comments

@oraNod
Copy link

oraNod commented Apr 30, 2024

Required for ansible/ansible-documentation#1353 Blocked by #525

The purpose of this issue is to create an environment in the ansible-documentation repo that holds secrets for the GitHub app with read/write permissions to the contents of the destination repo in the ansible-community org. This is needed to push resources from the ansible-documentation repo to the destination repo that builds on ReadTheDocs.

As Sviat mentioned in the PR, we can also use a deployment key. It's public part is added to the target repo and the private one goes to this repo's secrets.

Additionally, we should restrict access to the deploy job in the workflow to members of the community-docs-maintainers group. The environment should be configured so that members of that group control when the job runs.

@oraNod oraNod added Epic: RTD migration Work related to migrating community docs hosting to ReadTheDocs task labels Apr 30, 2024
@oraNod
Copy link
Author

oraNod commented Apr 30, 2024

@oraNod
Copy link
Author

oraNod commented May 20, 2024

Closing as we can actually specify the environment in the workflow and it will be created when merged. https://github.com/ansible/ansible-documentation/pull/1353/files#diff-556c4624ec829c57c68bca98085f1fac2a96f6af1ff4dc3c42e4a8f20e2a10abR145

@oraNod oraNod closed this as completed May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic: RTD migration Work related to migrating community docs hosting to ReadTheDocs task
Projects
None yet
Development

No branches or pull requests

1 participant