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

Feature - ARM Wiki Workflow addition #1068

Merged

Conversation

microtechno9000
Copy link
Collaborator

@microtechno9000 microtechno9000 commented Feb 29, 2024

added workflow from

Description

New feature, embedded the ARM Wiki within the main repository allowing users to checkout, edit and then commit changes to the ARM Wiki through the GitHub PR process.
GitHub action using Bi-directional Wiki Sync Action
Only using a one way job, pushing changes from the ARM repository to the Wiki. Pushes from the Wiki to ARM are not required.

Action notes

  • Triggered on PR to main, once approved, and only when changes to arm_wiki are made
  • Calls Bi-directional Wiki Sync Action using GitHub auth token to push change to the wiki repository
  • requires create:write to push changes

Fixes # Nil

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

  • Tested on Microtechno9000's main, pushing PRs and the action completed, pushing the wiki

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have tested that my fix is effective or that my feature works

Change log:

Include the details of changes made here

  • New folder 'arm_wiki' includes all of the *.md files
  • New GitHub workflow file

Logs

Edit: logs from test on local repository attached Job Action

job-sync-docs-to-wiki.txt

Copy link

sonarcloud bot commented Mar 3, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@microtechno9000
Copy link
Collaborator Author

@shitwolfymakes updated the wiki files to include reference to the new workflow, allowing users to edit the wiki with a PR

also added some context / help for some of the ownership issues seen recently

@shitwolfymakes
Copy link
Member

Great job!

@shitwolfymakes shitwolfymakes merged commit f56eff5 into automatic-ripping-machine:main Mar 3, 2024
9 of 10 checks passed
@microtechno9000 microtechno9000 deleted the feature_armwiki branch March 19, 2024 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Added Feature has been added
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants