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

Compare userguide from branch (generation compatibility) #3

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

Conversation

Vrixyz
Copy link
Contributor

@Vrixyz Vrixyz commented Nov 21, 2024

This PR enables to easily see modifications made to user guides, without having to run diff scripts locally

  • While this PR doesn´t change add much features compared to github's builtin diff, but will be useful for Migrate ncollide docs #2 which now generates the user guide.

This uses pull_request_target, which runs the CI on the base (target) repository, opposed to pull_request which runs on the fork repository. That's by github's design to limit security concerns, so we can use github token to comment.

⚠️ This is still an advanced technique which will require some care on future PRs, because we're running external code from the PR.

Note this new CI step doesn´t run for this PR, because:

  • pull_request_target doesn't exist in the target branch, so it won't run.
  • This could run if we used pull_request, but we wouldn't be able to comment h ere (a different repository from the PR branch.
  • I didn´t modify anything in the watched path.

@Vrixyz Vrixyz changed the title Compare target branch Compare userguide from branch (generation compatibility) Nov 21, 2024
Comment on lines +1 to +3
name: Compare generated user guides

permissions:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

add a description for this workflow

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.

1 participant