Skip to content
This repository has been archived by the owner on Feb 24, 2021. It is now read-only.

Add a Function to Helper Module to automatically upload *_wikicontent.zip to GitHub #142

Closed
PlagueHO opened this issue Jun 7, 2017 · 10 comments · Fixed by #324
Closed
Labels
enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community.

Comments

@PlagueHO
Copy link
Contributor

PlagueHO commented Jun 7, 2017

For the DSC Resources with autodocumenting/wiki content, this content has to be manually uploaded when the module is released. The Wiki content is published as an AppVeyor artifact using the CI process.

However, being manual it is error prone and not a good use of time.

GitHub provides a mechanism where the content can be uploaded by using a Git Clone/Git Push:
https://help.github.com/articles/adding-and-editing-wiki-pages-locally/

What would be useful was a simple cmdlet that could be called either manually or using automation (during the release process the DSC team uses) to:

  1. Clone the Wiki Git repo
  2. Download the AppVeyor artifact
  3. Unzip the artifact to the Wiki Git repo
  4. Add a commit message and tag.
  5. Push the Wiki Git repo.

This shouldn't be too difficult to achieve.

@kwirkykat , @mbreakey3 , @zjalexander is this a function that could be automatically called during the release phase for specific modules?

@kwirkykat
Copy link
Member

@PlagueHO Yeah I can add it to the release script. You have any preference on what repo I try it out on first?

@kwirkykat kwirkykat added the enhancement The issue is an enhancement request. label Jul 11, 2017
@PlagueHO
Copy link
Contributor Author

PlagueHO commented Jul 11, 2017

@kwirkykat - awesome! I'll get the script created and submit a PR into this repo as a "Helper" function. That way it could be community reviewed etc. I just wanted to check that this would be useful before creating it.
But in answer to your question: xNetworking

@BrianFarnhill
Copy link
Contributor

I'll help test it with SharePointDsc if you like guys - just let me know

@PlagueHO
Copy link
Contributor Author

Awesome, thanks @BrianFarnhill - I'll put it together tomorrow.

@PlagueHO
Copy link
Contributor Author

Haven't got round to this one yet. Will see if I can get to it this week. Sorry!

@johlju
Copy link
Contributor

johlju commented May 30, 2018

There was one issue left from the issue PowerShell/DscResources#167; "Update Wiki documentation in the build pipeline when PR is merged to master branch.". I think this issue will solve that, so adding it here as a reference.

@X-Guardian
Copy link
Contributor

Hi guys, I've written a function that will do this, and am testing it now. I'll raise a PR when I'm happy with it.

@PlagueHO
Copy link
Contributor Author

PlagueHO commented Jun 5, 2019

Cool! Thanks @X-Guardian - looking forward to this. Ideally this will get triggered automatically as part of the build that occurs on the merge to master like what happens with the Example publishing automation.

@X-Guardian
Copy link
Contributor

I've plugged it into the Invoke-AppVeyorDeployTask with an additional OptIn ValidateSet member to trigger it. I've added the actual function into the WikiPages module.

I'm just trying to add some additional error processing around the calls to Git, but being an external executable, it is a pain!

@X-Guardian
Copy link
Contributor

OK guys, pull request #324 complete. Let me know what you think.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants