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

Create docs release type #109

Open
jmgilman opened this issue Jan 8, 2025 · 0 comments
Open

Create docs release type #109

jmgilman opened this issue Jan 8, 2025 · 0 comments

Comments

@jmgilman
Copy link
Collaborator

jmgilman commented Jan 8, 2025

Create a docs release type that deploys documentation built by a target to AWS S3. It uses the following inputs:

  • AWS S3 bucket name to publish to
  • Optional prefix path to use in the bucket
  • Whether to enable per-branch documentation or not

Since the setup phase already includes support for authenticating with AWS, additional authentication information is not required. The flow of the release is as follows:

  • Run the configured target
  • Validate artifacts are produced
  • (Optional) Append the current branch name to the path if per-branch documentation is enabled
  • Upload all artifacts (using their relative file path and the bucket prefix) to AWS S3
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

No branches or pull requests

1 participant