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

add automated docs building and publishing #391

Merged
merged 2 commits into from
Jul 5, 2022

Conversation

briantist
Copy link
Contributor

@briantist briantist commented May 3, 2022

SUMMARY

As discussed: ansible/community#644 (comment)

I will wait until we're sure it's working before adding a new PR deleting the RST files in docs/ and the related workflow.
Follow-up PR is up: #392

ISSUE TYPE
  • Docs Pull Request

@briantist
Copy link
Contributor Author

Following discussion in WWG, I've modified the PR workflow to remove the publishing step, which is the step that runs with contents: write permission.

What's left is the build job (read-only, only part that touches PR code), and the separate job for posting a comment on the PR, and doesn't have contents access at all.

This will let us still:

  • verify that PRs are not causing docs problems
  • post a helpful comment showing (in diff format) what's changed, and where to download the rendered docs for local review

The push/schedule workflow remains the same, with build + publish

@nitzmahone nitzmahone self-requested a review June 7, 2022 20:01
Copy link
Member

@nitzmahone nitzmahone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks as safe as it can be for the push cases- thanks!

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