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 documentation related build and checks to GitHub workflows #186

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

cmcgee1024
Copy link
Member

There's nothing in the pull request verification that checks if the command-line references are up-to-date. Add a job to the pull request update workflow that verifies this.

There's nothing in the release build workflow that generates the documentation and uploads the documentation artifacts so that they can be published. Add a step to the build release job that generates the documentation so that it can be published to swift.org.

There's nothing in the pull request verification that checks if
the command-line references are up-to-date. Add a job to the pull
request update workflow that verifies this.

There's nothing in the release build workflow that generates the
documentation and uploads the documentation artifacts so that they
can be published. Add a step to the build release job that generates
the documentation so that it can be published to swift.org.
@cmcgee1024 cmcgee1024 changed the title Add documentation releated build and checks to GitHub workflows Add documentation related build and checks to GitHub workflows Nov 18, 2024
name: swiftly-docs
path: .build/docs/**
if-no-files-found: error
retention-days: 1

Choose a reason for hiding this comment

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

any reason we're using a retention rate of 1 for artifacts? Isn't that limiting for engineers?

Copy link
Member Author

Choose a reason for hiding this comment

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

any reason we're using a retention rate of 1 for artifacts? Isn't that limiting for engineers?

This runs on each pull request update. I set the retention low here, but high for the releases.

@cmcgee1024
Copy link
Member Author

@swift-ci test macOS

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.

2 participants