Skip to content

Commit

Permalink
Release pipeline scaffolding
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Allen committed Jan 17, 2018
1 parent 63be446 commit 6a7b03d
Show file tree
Hide file tree
Showing 8 changed files with 400 additions and 1 deletion.
20 changes: 20 additions & 0 deletions AppVeyor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# See http://www.appveyor.com/docs/appveyor-yml for many more options

#Publish to PowerShell Gallery with this key
environment:
NuGetApiKey:
secure: Q40zzAtBNk4T17gd+chHHfIngxVnwmX62pMcnQOfLBb1ZEcV65gLUsbEt7Fdboq2

# Allow WMF5 (i.e. PowerShellGallery functionality)
os: WMF 5

# Skip on updates to the readme.
# We can force this by adding [skip ci] or [ci skip] anywhere in commit message
skip_commits:
message: /updated readme.*|update readme.*s/

build: false

#Kick off the CI/CD pipeline
test_script:
- ps: . .\CMLimitingCollection.Build.ps1
56 changes: 56 additions & 0 deletions CMLimitingCollection.Build.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
function Resolve-Module
{
[Cmdletbinding()]
param
(
[Parameter(Mandatory)]
[string[]]$Name
)

Process
{
foreach ($ModuleName in $Name)
{
$Module = Get-Module -Name $ModuleName -ListAvailable
Write-Verbose -Message "Resolving Module $($ModuleName)"

if ($Module)
{
$Version = $Module | Measure-Object -Property Version -Maximum | Select-Object -ExpandProperty Maximum
$GalleryVersion = Find-Module -Name $ModuleName -Repository PSGallery | Measure-Object -Property Version -Maximum | Select-Object -ExpandProperty Maximum

if ($Version -lt $GalleryVersion)
{

if ((Get-PSRepository -Name PSGallery).InstallationPolicy -ne 'Trusted') { Set-PSRepository -Name PSGallery -InstallationPolicy Trusted }

Write-Verbose -Message "$($ModuleName) Installed Version [$($Version.tostring())] is outdated. Installing Gallery Version [$($GalleryVersion.tostring())]"

Install-Module -Name $ModuleName -Force
Import-Module -Name $ModuleName -Force -RequiredVersion $GalleryVersion
}
else
{
Write-Verbose -Message "Module Installed, Importing $($ModuleName)"
Import-Module -Name $ModuleName -Force -RequiredVersion $Version
}
}
else
{
Write-Verbose -Message "$($ModuleName) Missing, installing Module"
Install-Module -Name $ModuleName -Force
Import-Module -Name $ModuleName -Force -RequiredVersion $Version
}
}
}
}

# Grab nuget bits, install modules, set build variables, start build.
Get-PackageProvider -Name NuGet -ForceBootstrap | Out-Null

Resolve-Module Psake, PSDeploy, Pester, BuildHelpers

Set-BuildEnvironment

Invoke-psake .\psake.ps1
exit ( [int]( -not $psake.build_success ) )
58 changes: 58 additions & 0 deletions CMLimitingCollection.PSDeploy.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Generic module deployment.
# This stuff should be moved to psake for a cleaner deployment view

# ASSUMPTIONS:

# folder structure of:
# - RepoFolder
# - This PSDeploy file
# - ModuleName
# - ModuleName.psd1

# Nuget key in $ENV:NugetApiKey

# Set-BuildEnvironment from BuildHelpers module has populated ENV:BHProjectName

# Publish to gallery with a few restrictions
if(
$env:BHProjectName -and $env:BHProjectName.Count -eq 1 -and
$env:BHBuildSystem -ne 'Unknown' -and
$env:BHBranchName -eq "master" -and
$env:BHCommitMessage -match '!deploy'
)
{
Deploy Module {
By PSGalleryModule {
FromSource $ENV:BHProjectName
To PSGallery
WithOptions @{
ApiKey = $ENV:NugetApiKey
}
}
}
}
else
{
"Skipping deployment: To deploy, ensure that...`n" +
"`t* You are in a known build system (Current: $ENV:BHBuildSystem)`n" +
"`t* You are committing to the master branch (Current: $ENV:BHBranchName) `n" +
"`t* Your commit message includes !deploy (Current: $ENV:BHCommitMessage)" |
Write-Host
}

# Publish to AppVeyor if we're in AppVeyor
if(
$env:BHProjectName -and $ENV:BHProjectName.Count -eq 1 -and
$env:BHBuildSystem -eq 'AppVeyor'
)
{
Deploy DeveloperBuild {
By AppVeyorModule {
FromSource $ENV:BHProjectName
To AppVeyor
WithOptions @{
Version = $env:APPVEYOR_BUILD_VERSION
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ function Set-LimitingCollectionForFolder {
References:
.EXAMPLE
Set-LimitingCollection -Collections PR1 -LimitingCollectionName "Windows desktops"
Set-LimitingCollection -Path "\Software Library\Overview\Application Management\Applications" -LimitingCollectionName "Windows desktops"
Set the limiting collection to "Windows desktops"
#>
[CmdletBinding( DefaultParameterSetName = "LimitingCollectionName" ) ]
Expand Down
92 changes: 92 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

## Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the README.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.

## Code of Conduct

### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

### Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

### Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

### Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
7 changes: 7 additions & 0 deletions Licence
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2018 Mark Henry Allen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
92 changes: 92 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# CMLimitingCollection

In Microsoft System Center Configuration Manager, given a collection folder the limiting collection of each collection therein will be set to the value specified.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

PowerShell
The SCCM console is required
An account with permission to modify collections

### Installing

#### From source

Copy locally and then import the module.

`Import-Module .\CMLimitingCollection\CMLimitingCollection.psm1`

#### From PowerShell Gallery

`Import-Module CMLimitingCollection`

### Basic usage

1. Copy the folder path from the console folder

![Image of copying the console folder path](https://markallenit.com/blog/wp-content/uploads/2017/12/Copy-console-path.png)

2. Invoke the Set-LimitingCollection funtion and paste the console folder path and the target limiting collection name

`Set-LimitingCollection -Path "\Software Library\Overview\Application Management\Applications" -LimitingCollectionName "Windows desktops"`

### Syntax

Set-LimitingCollectionForFolder -Path <String> -LimitingCollectionName <Object> [-SiteCode <String>] [-SiteServer <String>] [<CommonParameters>]

Set-LimitingCollectionForFolder -Path <String> -LimitingCollectionId <Object> [-SiteCode <String>] [-SiteServer <String>] [<CommonParameters>]

.PARAMETER Path
The path to the console folder containing the collections to be updated.

.PARAMETER LimitingCollectionName
The name of the new limiting collection.

.PARAMETER LimitingCollectionId
The CollectionId of the new limiting collection.

.PARAMETER SiteCode
[Optional] Connect to the specified site. If no value is provided the default site
used by the locally installed SCCM client will be used.

.PARAMETER SiteServer
[Optional] Connect to the specified site server. If no value is provided the default site
server used by the locally installed SCCM console will be used.

## Running the tests

Unit tests can be run using Invoke-Pester

## Built With

* PowerShell
* Microsoft System Center Configuration Manager
* Pester

## Tested With

* PowerShell 5.1
* Microsoft System Center Configuration Manager 1706
* Pester 3.4.0

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

## Authors

* **Mark Allen** - *Initial work* - [markhallen](https://github.com/markhallen)

See also the list of [contributors](https://github.com/markhallen/CMLimitingCollection/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
Loading

0 comments on commit 6a7b03d

Please sign in to comment.