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

Documentation GH Action And PR Template Updates #364

Merged
merged 4 commits into from
Nov 8, 2024

Conversation

TimothyWillard
Copy link
Contributor

Describe your changes.

  • Updates the GitBook sync GitHub action to trigger on 1) a merged PR to either main or documentation-gitbook or 2) a push to documentation-gitbook. This will make syncing the GitBook more responsive to keep the two sources of documentation more up to date with one another.
  • Added a section to the PR template to ask for an explicit description of user interface changes separate from the description of the issue as a whole.

Does this pull request make any user interface changes? If so please describe.

n/a

What does your pull request address? Tag relevant issues.

This pull request addresses GH-363.

Tag relevant team members.

@alsnhll @emprzy @jcblemai @pearsonca @saraloo

* Change trigger from cron to on merge to either `main` or
  `documentation-gitbook` or push to `documentation-gitbook`.
* Change assignees to reviewers.
* Change name slightly to be human readable.
Add a section to the PR template that explicitly asks users to describe
any user interface changes.
Copy link
Contributor

@pearsonca pearsonca left a comment

Choose a reason for hiding this comment

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

Looks basically right. Want a bit more prompting the PR template, different default set of reviewers.

But ready to chat at on the call @ 11.

.github/pull_request_template.md Show resolved Hide resolved
.github/workflows/create-docs-pr.yml Outdated Show resolved Hide resolved
Add prompt for where said changes to UI are documented per @pearsonca's suggestion.

Co-authored-by: Carl A. B. Pearson <[email protected]>
@TimothyWillard TimothyWillard force-pushed the GH-363/documentation-pull-request-updates branch from e669e87 to 56eb114 Compare October 28, 2024 14:29
@TimothyWillard TimothyWillard added documentation Relating to ReadMEs / gitbook / vignettes / etc. meta/workflow Relating to CI / issue templates / testing frameworks / etc. labels Oct 28, 2024
@saraloo
Copy link
Contributor

saraloo commented Nov 4, 2024

Thanks Tim - this is good to me. Just confirming, as in other PRs this would always require two reviewers? Hopefully that doesn't hold up merges but will try to keep on top of things.

@TimothyWillard
Copy link
Contributor Author

Just confirming, as in other PRs this would always require two reviewers?

Yes, that's correct. The 2 reviewers for a PR is a repository setting and cannot be changed on a per PR basis.

@TimothyWillard TimothyWillard merged commit b9cef88 into main Nov 8, 2024
@TimothyWillard TimothyWillard deleted the GH-363/documentation-pull-request-updates branch November 8, 2024 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relating to ReadMEs / gitbook / vignettes / etc. meta/workflow Relating to CI / issue templates / testing frameworks / etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants