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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃懛 Add a GitHub action that executes the scripts of the building tools #738

Open
FH-Inway opened this issue Jun 11, 2023 · 1 comment

Comments

@FH-Inway
Copy link
Member

After adding or changing a cmdlet of the module, the documentation and parameter unit tests should be updated (see https://github.com/d365collaborative/d365fo.tools/wiki/Building-tools).
So far, this has been a manual task. To make this easier in the future, as a first step, I'd like to add a Github action that for now needs to be triggered manually. The action would execute the scripts to format the commend based help, update the parameter unit tests and update the documentation. If there are changes resulting from these scripts, the action would create a pull request for them.

In the future, this could be added to the action that validates pull requests and make the changes directly in the pull request branch.

See https://github.com/FH-Inway/d365fo.tools/actions/runs/5236416468/jobs/9453943953 for an example run of the action and FH-Inway#62 for an example of a pull request created by it.

@FH-Inway
Copy link
Member Author

I did some testing with this today. The peter-evans/create-pull-request action that is currently used to create the pull request supports the scenario to create pull requests with changes for pull requests: Use case: Create a pull request to modify/fix pull requests

Unfortunately, this does not work for pull requests from forks 馃槩
Reasons are explained in the use case description.

So until we find a different way to do this, the guidance would be that contributors should run the action in their fork repository against the branch that is used for their pull request.

We can also do it for them, but it is a bit round-about: First, we would need to pull their branch into the main repository or one of our forks. There, we can run the action, which creates a pull request with the changes. We would then merge that pr and then create a pull request from the modified branch back to their branch.

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