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

[actions] Create an action that comments on PRs when code affects documentation #3068

Open
Daltz333 opened this issue Jan 9, 2021 · 2 comments · May be fixed by #3672
Open

[actions] Create an action that comments on PRs when code affects documentation #3068

Daltz333 opened this issue Jan 9, 2021 · 2 comments · May be fixed by #3672
Labels
build Monorepo organization, gradle/cmake, upstream_utils, etc type: docs Related to documentation and information. type: feature Brand new functionality, features, pages, workflows, endpoints, etc.

Comments

@Daltz333
Copy link
Member

Daltz333 commented Jan 9, 2021

Any code that has been referenced or included in frc-docs should have an associated documentation PR. We should create an action or CI that will

  1. Grabs the current diff
  2. Create a list of URLs that will then be matched with frc-docs source
  3. Comment on the PR that the associated frc-docs line # has been affected and to update that line.
@Daltz333 Daltz333 added type: feature Brand new functionality, features, pages, workflows, endpoints, etc. type: docs Related to documentation and information. labels Jan 9, 2021
@Starlight220
Copy link
Member

@Daltz333 isn't this solved by Inspector?
Or could be fixed by one of #3069 / #3672?

I'm honestly not sure if it'll be that significant of a workflow improvement compared to the current setup with Inspector.

@Daltz333
Copy link
Member Author

Daltz333 commented May 2, 2022

Inspector does not automatically update when code changes. This would be useful and push the burden to whoever updates the example, as it should be IMO.

@calcmogul calcmogul added the build Monorepo organization, gradle/cmake, upstream_utils, etc label Aug 2, 2023
@Starlight220 Starlight220 linked a pull request Aug 1, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Monorepo organization, gradle/cmake, upstream_utils, etc type: docs Related to documentation and information. type: feature Brand new functionality, features, pages, workflows, endpoints, etc.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants