Update pr instructions gha 5165

roslynwythe commented 1 year ago

Fixes #6 Fixes https://github.com/hackforla/website/issues/5165

What changes did you make?

new pr instruction and template for previewing CONTRIBUTING.md
refactor code by moving instruction formatting to create-instruction.js

Why did you make the changes (we will use this info to test)?

The existing pr instructions are not accurate since CONTRIBUTING.md cannot be previewed locally, only on a GItHub repo
Refactoring is also preparation for adding logic to modify pr instructions depending on the files changed in the PR

Screenshots of Proposed Changes Of The Website (if any, please do not screen shot code changes)

no visual changes

github-actions[bot] commented 1 year ago

Want to review this pull request? Take a look at this documentation for a step by step guide!

From your project repository, check out a new branch and test the changes.

%3C!--%20Note:%20Commandline%20instructions%20are%20added%20into%20where%20the%20placeholder%20string%20first%20appears%20---%3E%0A%0AWant%20to%20review%20this%20pull%20request?%20Take%20a%20look%20at%20%5Bthis%20documentation%5D(https://github.com/hackforla/website/wiki/How-to-Review-Pull-Requests)%20for%20a%20step%20by%20step%20guide!%0A%0AFrom%20your%20project%20repository,%20check%20out%20a%20new%20branch%20and%20test%20the%20changes.%0A%0A%60%60%60%0Agit%20checkout%20-b%20roslynwythe-update-pr-instructions-gha-5165%20gh-pages%0Agit%20pull%20https://github.com/roslynwythe/website.git%20update-pr-instructions-gha-5165%0A%60%60%60%0A%3C!--%20Note:%20Commandline%20instructions%20are%20added%20into%20where%20the%20placeholder%20string%20first%20appears%20---%3E%0A%0A------------------%0A%0ANote%20that%20CONTRIBUTING.md%20cannot%20previewed%20locally;%20rather%20it%20should%20be%20previewed%20at%20this%20URL:%0A%0A%60%60%60%0Ahttps://github.com/roslynwythe/website/blob/update-pr-instructions-gha-5165/CONTRIBUTING.md%20%20%0A%60%60%60%0A

roslynwythe commented 1 year ago

The reason the instruction is decoded is because the updated GHA that generates, formats, decodes and uploads the instruction artifact - “Add Pull Request Instructions” (.github/workflows/pr-instructions.yml) ran in response to the trigger of this PR with the context and Ref of the issue branch, however, the updated script post-comment.js invoked by the "WR Add Pull Request Instruction" did not run, because workflows triggered on "workflow_run" reference the default branch of the repository , i.e, gh-pages. The instruction should have been decoded in post-comment.js but the updated post-comment.js did not execute.

However see in which the updated post-comment.js did run, because the default branch on my repo was modified.

roslynwythe / website